JMP 12 Statistical Analysis Software JSL Syntax Reference

Below you will find brief information for JMP 12. This document serves as a comprehensive JSL Syntax Reference, detailing the functions, operators, and messages available for scripting within the JMP statistical discovery software. Users can explore various JSL commands, understand their arguments, and utilize them for data manipulation, constructing display boxes, and creating custom JMP applications, thereby enhancing their analytical capabilities and workflow automation.
PDF
Document
Version 12
JSL Syntax Reference
“The real voyage of discovery consists not in seeking new
landscapes, but in having new eyes.”
Marcel Proust
JMP, A Business Unit of SAS
SAS Campus Drive
Cary, NC 27513
The correct bibliographic citation for this manual is as follows: SAS Institute Inc. 2015.
JMP&reg; 12 JSL Syntax Reference. Cary, NC: SAS Institute Inc.
JMP&reg; 12 JSL Syntax Reference
Copyright &copy; 2015, SAS Institute Inc., Cary, NC, USA
ISBN 978‐1‐62959‐454‐5 (Hardcopy)
ISBN 978‐1‐62959‐456‐9 (EPUB)
ISBN 978‐1‐62959‐457‐6 (MOBI)
ISBN 978‐1‐62959‐455‐2 (PDF)
All rights reserved. Produced in the United States of America.
For a hard-copy book: No part of this publication may be reproduced, stored in a retrieval
system, or transmitted, in any form or by any means, electronic, mechanical, photocopying,
or otherwise, without the prior written permission of the publisher, SAS Institute Inc.
For a web download or e-book: Your use of this publication shall be governed by the terms
established by the vendor at the time you acquire this publication.
The scanning, uploading, and distribution of this book via the Internet or any other means
without the permission of the publisher is illegal and punishable by law. Please purchase
only authorized electronic editions and do not participate in or encourage electronic piracy
of copyrighted materials. Your support of others’ rights is appreciated.
U.S. Government License Rights; Restricted Rights: The Software and its documentation is
commercial computer software developed at private expense and is provided with
RESTRICTED RIGHTS to the United States Government. Use, duplication or disclosure of
the Software by the United States Government is subject to the license terms of this
Agreement pursuant to, as applicable, FAR 12.212, DFAR 227.7202‐1(a), DFAR 227.7202‐3(a)
and DFAR 227.7202‐4 and, to the extent required under U.S. federal law, the minimum
restricted rights as set out in FAR 52.227‐19 (DEC 2007). If FAR 52.227‐19 is applicable, this
provision serves as notice under clause (c) thereof and no other notice is required to be
affixed to the Software or documentation. The Government’s rights in Software and
documentation shall be only those set forth in this Agreement.
SAS Institute Inc., SAS Campus Drive, Cary, North Carolina 27513‐2414.
March 2015
SAS&reg; and all other SAS Institute Inc. product or service names are registered trademarks or
trademarks of SAS Institute Inc. in the USA and other countries. &reg; indicates USA
registration.
Other brand and product names are trademarks of their respective companies.
Technology License Notices
•
Scintilla ‐ Copyright &copy; 1998‐2014 by Neil Hodgson &lt;[email protected]&gt;.
All Rights Reserved.
Permission to use, copy, modify, and distribute this software and its documentation for
any purpose and without fee is hereby granted, provided that the above copyright
notice appear in all copies and that both that copyright notice and this permission
notice appear in supporting documentation.
NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL NEIL
HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
•
Telerik RadControls: Copyright &copy; 2002‐2012, Telerik. Usage of the included Telerik
RadControls outside of JMP is not permitted.
•
ZLIB Compression Library ‐ Copyright &copy; 1995‐2005, Jean‐Loup Gailly and Mark Adler.
•
Made with Natural Earth. Free vector and raster map data @ naturalearthdata.com.
•
Packages ‐ Copyright &copy; 2009‐2010, St&eacute;phane Sudre (s.sudre.free.fr). All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
Neither the name of the WhiteBox nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
•
iODBC software ‐ Copyright &copy; 1995‐2006, OpenLink Software Inc and Ke Jin
(www.iodbc.org). All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
‒ Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
‒ Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
‒ Neither the name of OpenLink Software Inc. nor the names of its contributors may
be used to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL OPENLINK OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
•
bzip2, the associated library “libbzip2”, and all documentation, are Copyright &copy;
1996‐2010, Julian R Seward. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
The origin of this software must not be misrepresented; you must not claim that you
wrote the original software. If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but is not required.
Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
The name of the author may not be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR “AS IS” AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
•
R software is Copyright &copy; 1999‐2012, R Foundation for Statistical Computing.
•
MATLAB software is Copyright &copy; 1984‐2012, The MathWorks, Inc. Protected by U.S.
and international patents. See www.mathworks.com/patents. MATLAB and Simulink
are registered trademarks of The MathWorks, Inc. See www.mathworks.com/
trademarks for a list of additional trademarks. Other product or brand names may be
trademarks or registered trademarks of their respective holders.
•
libopc is Copyright &copy; 2011, Florian Reuter. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
‒ Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
‒ Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and / or other
materials provided with the distribution.
‒ Neither the name of Florian Reuter nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
•
libxml2 ‐ Except where otherwise noted in the source code (e.g. the files hash.c, list.c
and the trio files, which are covered by a similar licence but with different Copyright
notices) all the files are:
Copyright &copy; 1998 ‐ 2003 Daniel Veillard. All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the “Software”), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
DANIEL VEILLARD BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Daniel Veillard shall not be used in
advertising or otherwise to promote the sale, use or other dealings in this Software
without prior written authorization from him.
Get the Most from JMP&reg;
Whether you are a first‐time or a long‐time user, there is always something to learn
about JMP.
Visit JMP.com to find the following:
•
live and recorded webcasts about how to get started with JMP
•
video demos and webcasts of new features and advanced techniques
•
details on registering for JMP training
•
schedules for seminars being held in your area
•
success stories showing how others use JMP
•
a blog with tips, tricks, and stories from JMP staff
•
a forum to discuss JMP with other users
http://www.jmp.com/getstarted/
Contents
JSL Syntax Reference
1
Learn about JMP
Documentation and Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Formatting Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
JMP Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
JMP Documentation Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
JMP Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Additional Resources for Learning JMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Sample Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Learn about Statistical and JSL Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Learn JMP Tips and Tricks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Tooltips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMP User Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMPer Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMP Books by Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
The JMP Starter Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2
JSL Functions
Summary of Functions, Operators, and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Assignment Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Character Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Character Pattern Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Comment Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Comparison Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Conditional and Logical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Date and Time Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Discrete Probability Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
10
JSL Syntax Reference
Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Expression Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
File Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Financial Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Graphic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
MATLAB Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
MATLAB JSL Function Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
MATLAB JSL Scriptable Object Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Matrix Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Numeric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Optimization Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Probability Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Programming Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
R Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Random Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Row Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Row State Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
SAS Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
SQL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Statistical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Transcendental Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Trigonometric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Utility Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Platform Scripting Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Fit Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Scripting Options for All Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Individual Platform Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
3
JSL Messages
Summary of Messages for Objects and Display Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Alpha Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Associative Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
JSL Syntax Reference
11
Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Data Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Datafeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Display Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
All Display Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Axis Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Border Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Data Grid Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Frame Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Matrix Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Nom Axis Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Number Col Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Outline Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Panel Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Plot Col Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Slider Boxes and Range Slider Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
String Col Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Tab Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Table Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Text Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Dynamic Link Libraries (DLLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Response Screening . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Tabulate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
R Integration Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
SAS Integration Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Metadata Server Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
SAS Server Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Stored Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
SAS Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
12
JSL Syntax Reference
Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Sockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Tree Node and Tree Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Triangulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Other Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Zip Archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Journals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Index
JSL Syntax Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Chapter 1
Learn about JMP
Documentation and Additional Resources
This chapter includes the following information:
•
book conventions
•
JMP documentation
•
JMP Help
•
additional resources, such as the following:
‒ other JMP documentation
‒ tutorials
‒ indexes
‒ Web resources
Figure 1.1 The JMP Help Home Window on Windows
Contents
Formatting Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
JMP Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
JMP Documentation Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
JMP Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Additional Resources for Learning JMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Sample Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Learn about Statistical and JSL Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Learn JMP Tips and Tricks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Tooltips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMP User Community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMPer Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
JMP Books by Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
The JMP Starter Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 1
JSL Syntax Reference
Learn about JMP
Formatting Conventions
15
Formatting Conventions
The following conventions help you relate written material to information that you see on
your screen.
•
Sample data table names, column names, pathnames, filenames, file extensions, and
folders appear in Helvetica font.
•
Code appears in Lucida Sans Typewriter font.
•
Code output appears in Lucida Sans Typewriter italic font and is indented farther than
the preceding code.
•
Helvetica bold formatting indicates items that you select to complete a task:
‒ buttons
‒ check boxes
‒ commands
‒ list names that are selectable
‒ menus
‒ options
‒ tab names
‒ text boxes
•
The following items appear in italics:
‒ words or phrases that are important or have definitions specific to JMP
‒ book titles
‒ variables
‒ script output
•
Features that are for JMP Pro only are noted with the JMP Pro icon
of JMP Pro features, visit http://www.jmp.com/software/pro/.
. For an overview
Note: Special information and limitations appear within a Note.
Tip: Helpful information appears within a Tip.
JMP Documentation
JMP offers documentation in various formats, from print books and Portable Document
Format (PDF) to electronic books (e‐books).
16
Learn about JMP
JMP Documentation
Chapter 1
JSL Syntax Reference
•
Open the PDF versions from the Help &gt; Books menu or from the JMP online Help footers.
•
All books are also combined into one PDF file, called JMP Documentation Library, for
convenient searching. Open the JMP Documentation Library PDF file from the Help &gt; Books
menu.
•
e‐books are available at online retailers. Visit http://www.jmp.com/support/downloads/
documentation.shtml for details.
•
You can also purchase printed documentation on the SAS website:
http://support.sas.com/documentation/onlinedoc/jmp/index.html
JMP Documentation Library
The following table describes the purpose and content of each book in the JMP library.
Document Title
Document Purpose
Document Content
Discovering JMP
If you are not familiar
with JMP, start here.
Introduces you to JMP and gets you
started creating and analyzing data.
Using JMP
Learn about JMP data
tables and how to
perform basic
operations.
Covers general JMP concepts and
features that span across all of JMP,
including importing data, modifying
columns properties, sorting data, and
connecting to SAS.
Basic Analysis
Perform basic analysis
using this document.
Describes these Analyze menu platforms:
•
Distribution
•
Fit Y by X
•
Matched Pairs
•
Tabulate
How to approximate sampling
distributions using bootstrapping and
modeling utilities are also included.
Chapter 1
JSL Syntax Reference
Learn about JMP
JMP Documentation
Document Title
Document Purpose
Document Content
Essential Graphing
Find the ideal graph
for your data.
Describes these Graph menu platforms:
•
Graph Builder
•
Overlay Plot
•
Scatterplot 3D
•
Contour Plot
•
Bubble Plot
•
Parallel Plot
•
Cell Plot
•
Treemap
•
Scatterplot Matrix
•
Ternary Plot
•
Chart
The book also covers how to create
background and custom maps.
Profilers
Learn how to use
interactive profiling
tools, which enable you
to view cross‐sections
of any response
surface.
Covers all profilers listed in the Graph
menu. Analyzing noise factors is
included along with running simulations
using random inputs.
Design of
Experiments Guide
Learn how to design
experiments and
determine appropriate
sample sizes.
Covers all topics in the DOE menu and
the Screening menu item in the Analyze &gt;
Modeling menu.
17
18
Learn about JMP
JMP Documentation
Chapter 1
JSL Syntax Reference
Document Title
Document Purpose
Document Content
Fitting Linear Models
Learn about Fit Model
platform and many of
its personalities.
Describes these personalities, all
available within the Analyze menu Fit
Model platform:
Specialized Models
Learn about additional
modeling techniques.
•
Standard Least Squares
•
Stepwise
•
Generalized Regression
•
Mixed Model
•
MANOVA
•
Loglinear Variance
•
Nominal Logistic
•
Ordinal Logistic
•
Generalized Linear Model
Describes these Analyze &gt; Modeling
menu platforms:
•
Partition
•
Neural
•
Model Comparison
•
Nonlinear
•
Gaussian Process
•
Time Series
•
Response Screening
The Screening platform in the Analyze &gt;
Modeling menu is described in Design of
Experiments Guide.
Multivariate
Methods
Read about techniques
for analyzing several
variables
simultaneously.
Describes these Analyze &gt; Multivariate
Methods menu platforms:
•
Multivariate
•
Cluster
•
Principal Components
•
Discriminant
•
Partial Least Squares
Chapter 1
JSL Syntax Reference
Learn about JMP
JMP Documentation
Document Title
Document Purpose
Document Content
Quality and Process
Methods
Read about tools for
evaluating and
improving processes.
Describes these Analyze &gt; Quality and
Process menu platforms:
Reliability and
Survival Methods
Consumer Research
Learn to evaluate and
improve reliability in a
product or system and
analyze survival data
for people and
products.
Learn about methods
for studying consumer
preferences and using
that insight to create
better products and
services.
•
Control Chart Builder and individual
control charts
•
Measurement Systems Analysis
•
Variability / Attribute Gauge Charts
•
Process Capability
•
Pareto Plot
•
Diagram
Describes these Analyze &gt; Reliability and
Survival menu platforms:
•
Life Distribution
•
Fit Life by X
•
Recurrence Analysis
•
Degradation and Destructive
Degradation
•
Reliability Forecast
•
Reliability Growth
•
Reliability Block Diagram
•
Survival
•
Fit Parametric Survival
•
Fit Proportional Hazards
Describes these Analyze &gt; Consumer
Research menu platforms:
•
Categorical
•
Multiple Correspondence Analysis
•
Factor Analysis
•
Choice
•
Uplift
•
Item Analysis
19
20
Learn about JMP
Additional Resources for Learning JMP
Chapter 1
JSL Syntax Reference
Document Title
Document Purpose
Document Content
Scripting Guide
Learn about taking
advantage of the
powerful JMP
Scripting Language
(JSL).
Covers a variety of topics, such as writing
and debugging scripts, manipulating
data tables, constructing display boxes,
and creating JMP applications.
JSL Syntax Reference
Read about many JSL
functions on functions
and their arguments,
and messages that you
send to objects and
display boxes.
Includes syntax, examples, and notes for
JSL commands.
Note: The Books menu also contains two reference cards that can be printed: The Menu Card
describes JMP menus, and the Quick Reference describes JMP keyboard shortcuts.
JMP Help
JMP Help is an abbreviated version of the documentation library that provides targeted
information. You can open JMP Help in several ways:
•
On Windows, press the F1 key to open the Help system window.
•
Get help on a specific part of a data table or report window. Select the Help tool
from
the Tools menu and then click anywhere in a data table or report window to see the Help
for that area.
•
Within a JMP window, click the Help button.
•
Search and view JMP Help on Windows using the Help &gt; Help Contents, Search Help, and
Help Index options. On Mac, select Help &gt; JMP Help.
•
Search the Help at http://jmp.com/support/help/ (English only).
Additional Resources for Learning JMP
In addition to JMP documentation and JMP Help, you can also learn about JMP using the
following resources:
•
Tutorials (see “Tutorials” on page 21)
•
Sample data (see “Sample Data Tables” on page 21)
•
Indexes (see “Learn about Statistical and JSL Terms” on page 21)
Chapter 1
JSL Syntax Reference
Learn about JMP
Additional Resources for Learning JMP
•
Tip of the Day (see “Learn JMP Tips and Tricks” on page 22)
•
Web resources (see “JMP User Community” on page 22)
•
JMPer Cable technical publication (see “JMPer Cable” on page 22)
•
Books about JMP (see “JMP Books by Users” on page 23)
•
JMP Starter (see “The JMP Starter Window” on page 23)
21
Tutorials
You can access JMP tutorials by selecting Help &gt; Tutorials. The first item on the Tutorials menu
is Tutorials Directory. This opens a new window with all the tutorials grouped by category.
If you are not familiar with JMP, then start with the Beginners Tutorial. It steps you through the
JMP interface and explains the basics of using JMP.
The rest of the tutorials help you with specific aspects of JMP, such as creating a pie chart,
using Graph Builder, and so on.
Sample Data Tables
All of the examples in the JMP documentation suite use sample data. Select Help &gt; Sample
Data Library to do the following actions to open the sample data directory.
To view an alphabetized list of sample data tables or view sample data within categories,
select Help &gt; Sample Data.
Sample data tables are installed in the following directory:
On Windows: C:\Program Files\SAS\JMP\&lt;version_number&gt;\Samples\Data
On Macintosh: \Library\Application Support\JMP\&lt;version_number&gt;\Samples\Data
In JMP Pro, sample data is installed in the JMPPRO (rather than JMP) directory. In JMP
Shrinkwrap, sample data is installed in the JMPSW directory.
Learn about Statistical and JSL Terms
The Help menu contains the following indexes:
Statistics Index Provides definitions of statistical terms.
Lets you search for information about JSL functions, objects, and display
boxes. You can also edit and run sample scripts from the Scripting Index.
Scripting Index
22
Learn about JMP
Additional Resources for Learning JMP
Chapter 1
JSL Syntax Reference
Learn JMP Tips and Tricks
When you first start JMP, you see the Tip of the Day window. This window provides tips for
using JMP.
To turn off the Tip of the Day, clear the Show tips at startup check box. To view it again, select
Help &gt; Tip of the Day. Or, you can turn it off using the Preferences window. See the Using JMP
book for details.
Tooltips
JMP provides descriptive tooltips when you place your cursor over items, such as the
following:
•
Menu or toolbar options
•
Labels in graphs
•
Text results in the report window (move your cursor in a circle to reveal)
•
Files or windows in the Home Window
•
Code in the Script Editor
Tip: You can hide tooltips in the JMP Preferences. Select File &gt; Preferences &gt; General (or JMP
&gt; Preferences &gt; General on Macintosh) and then deselect Show menu tips.
JMP User Community
The JMP User Community provides a range of options to help you learn more about JMP and
connect with other JMP users. The learning library of one‐page guides, tutorials, and demos is
a good place to start. And you can continue your education by registering for a variety of JMP
training courses.
Other resources include a discussion forum, sample data and script file exchange, webcasts,
and social networking groups.
To access JMP resources on the website, select Help &gt; JMP User Community.
JMPer Cable
The JMPer Cable is a yearly technical publication targeted to users of JMP. The JMPer Cable is
available on the JMP website:
http://www.jmp.com/about/newsletters/jmpercable/
Chapter 1
JSL Syntax Reference
Learn about JMP
Additional Resources for Learning JMP
23
JMP Books by Users
Additional books about using JMP that are written by JMP users are available on the JMP
website:
http://www.jmp.com/support/books.shtml
The JMP Starter Window
The JMP Starter window is a good place to begin if you are not familiar with JMP or data
analysis. Options are categorized and described, and you launch them by clicking a button.
The JMP Starter window covers many of the options found in the Analyze, Graph, Tables, and
File menus.
•
To open the JMP Starter window, select View (Window on the Macintosh) &gt; JMP Starter.
•
To display the JMP Starter automatically when you open JMP on Windows, select File &gt;
Preferences &gt; General, and then select JMP Starter from the Initial JMP Window list. On
Macintosh, select JMP &gt; Preferences &gt; Initial JMP Starter Window.
24
Learn about JMP
Additional Resources for Learning JMP
Chapter 1
JSL Syntax Reference
2
JSL Functions
Summary of Functions, Operators, and Messages
This topic provides abbreviated descriptions for many of JMP’s functions, operators, and
general object messages. For complete information about functions, see the JMP Scripting
Index. In JMP, select Help &gt; Scripting Index.
For information about platform messages, see the Scripting Platforms chapter in the Scripting
Guide.
Contents
Assignment Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Character Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Character Pattern Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Comment Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Comparison Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Conditional and Logical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Date and Time Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Discrete Probability Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Expression Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
File Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Financial Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Graphic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
MATLAB Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Matrix Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Numeric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Optimization Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Probability Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Programming Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
R Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Random Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Row Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Row State Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
SAS Integration Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
SQL Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Statistical Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Transcendental Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Trigonometric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Utility Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Platform Scripting Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Chapter 2
JSL Syntax Reference
JSL Functions
Assignment Functions
27
Assignment Functions
JSL also provides operators for in‐place arithmetic, or assignment operators. These operations
are all done in place, meaning that the result of the operation is assigned to the first argument.
The most basic assignment operator is the = operator (or the equivalent function Assign). For
example, if a is 3 and you do a+=4, then a becomes 7.
The first argument to an assignment function must be something capable of being assigned
(an L‐value). You cannot do something like 3+=4, because 3 is just a value and cannot be
reassigned. However, you can do something like a+=4, because a is a variable whose value you
can set.
Add To(a, b)
a+=b
Description
Adds a and b and places the sum into a.
Returns
The sum.
Arguments
a Must be a variable.
b Can be a variable, number, or matrix.
Notes
The first argument must be a variable, because its value must be able to accept a value
change. A number as the first argument produces an error.
For Add To(): Only two arguments are permitted. If one or no argument is specified, Add
To() returns a missing value. Any arguments after the first two are ignored.
For a+=b: More than two arguments can be strung together. JMP evaluates pairs from right
to left, and each sum is placed in the left‐hand variable. All arguments except the last must
be a variable.
Example
a+=b+=c
JMP adds b and c and places the sum into b. Then JMP adds a and b and places the sum
into a.
See Also
The Data Structures chapter in the Scripting Guide.
28
JSL Functions
Assignment Functions
Chapter 2
JSL Syntax Reference
Assign(a, b)
a=b
Description
Places the value of b into a.
Returns
The new value of a.
Arguments
a Must be a variable.
b Can be a variable, number, or matrix.
Notes
a must be a variable, because it must be able to accept a value change. A number as the first
argument produces an error. If b is some sort of expression, it’s evaluated first and the
result is placed into a.
Divide To(a, b)
a/=b
Description
Divides a by b and places the result into a.
Returns
The quotient.
Arguments
a Must be a variable.
b Can be a variable, number, or matrix.
See Also
The Data Structures chapter in the Scripting Guide.
Multiply To(a, b)
a*=b
Description
Multiplies a and b and places the product into a.
Returns
The product.
Arguments
a Must be a variable.
b Can be a variable, number, or matrix.
Chapter 2
JSL Syntax Reference
JSL Functions
Assignment Functions
29
Notes
The first argument must be a variable, because its value must be able to accept a value
change. A number as the first argument produces an error.
For Multiply To(): Only two arguments are permitted. If one or no argument is specified,
Multiply To() returns a missing value. Any arguments after the first two are ignored.
For a*=b: More than two arguments can be strung together. JMP evaluates pairs from right
to left, and each product is placed in the left‐hand variable. All arguments except the last
must be a variable.
Example
a*=b*=c
JMP multiplies b and c and places the product into b. Then JMP multiplies a and b and
places the product into a.
See Also
The Data Structures chapter in the Scripting Guide.
PostDecrement(a)
a-Description
Post‐decrement. Subtracts 1 from a and places the difference into a.
Returns
a‐1
Argument
a Must be a variable.
Notes
If a-- or Post Decrement(a) is inside another expression, the expression is evaluated first,
and then the decrement operation is performed. This expression is mostly used for loop
control.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
PostIncrement(a)
a++
Description
Post‐increment. Adds 1 to a and places the sum into a.
Returns
a+1
30
JSL Functions
Assignment Functions
Chapter 2
JSL Syntax Reference
Argument
a Must be a variable.
Notes
If a++ or PostIncrement(a) is inside another expression, the expression is evaluated first,
and then the increment operation is performed. Mostly used for loop control.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
Subtract To(a, b)
a-=b
Description
Subtracts b from a and places the difference into a.
Returns
The difference.
Arguments
a Must be a variable.
b Can be a variable, number, or matrix.
Notes
The first argument must be a variable, because its value must be able to accept a value
change. A number as the first argument produces an error.
For SubtractTo(): Only two arguments are permitted. If fewer than two or more than two
arguments is specified, SubtractTo() returns a missing value.
For a-=b: More than two arguments can be strung together. JMP evaluates pairs from right
to left, and each difference is placed in the left‐hand variable. All arguments except the last
must be a variable.
Example
a-=b-=c
JMP subtracts c from b and places the difference into b. Then JMP subtracts b from a and
places the difference into a.
See Also
The Data Structures chapter in the Scripting Guide.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
31
Character Functions
Most character functions take character arguments and return character strings, although
some take numeric arguments or return numeric data. Arguments that are literal character
strings must be enclosed in quotation marks.
The Types of Data chapter of the Scripting Guide provides more details about some of the
functions.
Blob To Char(blob, &lt;&quot;encoding&quot;&gt;)
Description
Reinterpret binary data as a Unicode string.
Returns
A string.
Arguments
blob a binary large object.
encoding Optional quoted string that specifies an encoding. Supported encodings are:
&quot;utf-8&quot;, &quot;utf-16le&quot;, &quot;utf-16be&quot;, &quot;us-ascii&quot;, &quot;iso-8859-1&quot;, and &quot;ascii-hex&quot;.
Notes
The optional argument ascii is intended to make conversions of blobs containing normal
ASCII data simpler when the data might contain CR, LF, or TAB characters (for example)
and those characters do not need any special attention.
Blob To Matrix(blob, &quot;type&quot;, bytes, &quot;endian&quot;, &lt;nCols&gt;)
Description
Creates a matrix by converting each byte in the blob to numbers.
Returns
A matrix that represents the blob.
Arguments
blob A blob or reference to a blob.
type A quoted string that contains the named type of number. The options are int, uint,
or float.
bytes Byte size of the data in the blob. Options are 1, 2, 4, or 8.
endian A quoted string that contains a named type that indicates whether the first byte is
the most significant. Options are as follows:
‒ &quot;big&quot; indicates that the first byte is the most significant.
‒ &quot;little&quot; indicates that the first byte is the least significant.
32
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
‒ &quot;native&quot; indicates that the machine’s native format should be used.
nCols Optional. Specify the number of columns in the matrix. The default value is 1.
Char(x, &lt;width&gt;, &lt;decimal&gt;)
Description
Converts an expression or numeric value into a character string.
Returns
A string.
Arguments
x an expression or a numeric value. An expression must be quoted with Expr().
Otherwise, its evaluated value is converted to a string.
width optional number that sets the maximum number of characters in the string.
decimal optional number that sets the maximum number of places after the decimal that
is included in the string.
Note
The width argument overrides the decimal argument.
Example
char(pi(), 10, 4)
&quot;3.1416&quot;
char(pi(), 3, 4)
&quot;3.1&quot;
Char To Blob(string, &lt;&quot;encoding&quot;&gt;)
Description
Converts a string of characters into a binary (blob).
Returns
A binary object.
Arguments
string Quoted string or a reference to a string.
encoding Optional quoted string that specifies an encoding. Supported encodings are:
&quot;utf-8&quot;, &quot;utf-16le&quot;, &quot;utf-16be&quot;, &quot;us-ascii&quot;, &quot;iso-8859-1&quot;, and &quot;ascii-hex&quot;.
Char To Hex(value, &lt;&quot;integer&quot; | &quot;encoding&quot;&gt;)
Hex(value, &lt;&quot;integer&quot; | &quot;encoding&quot;&gt;)
Description
Converts the given value and encoding into its hexadecimal representation.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
33
Returns
A hexadecimal string.
Arguments
value Any number, quoted string, or blob.
integer Switch that causes the value to be interpreted as an integer.
encoding Optional quoted string that specifies an encoding. The default encoding
supported for the hex code is &quot;utf-8&quot;. You can also specify one of these encodings:
&quot;utf-16le&quot;, &quot;utf-16be&quot;, &quot;us-ascii&quot;, &quot;iso-8859-1&quot;, &quot;ascii-hex&quot;, &quot;shift-jis&quot;, and
&quot;euc-jp&quot;.
Collapse Whitespace(&quot;text&quot;)
Description
Trims leading and trailing whitespace and replaces interior whitespace with a single space.
That is, if more than one white space character is present, the Collapse Whitespace
function replaces the two spaces with one space.
Returns
A quoted string.
Arguments
text A quoted string.
Concat(a, b)
Concat(A, B)
a||b
A||B
Description
For strings: Appends the string b to the string a. Neither argument is changed.
For lists: Appends the list b to the list a. Neither argument is changed.
For matrices: Horizontal concatenation of two matrices, A and B.
Returns
For strings: A string composed of the string a directly followed by the string b.
For lists: A list composed of the list a directly followed by the list b.
For matrices: A matrix.
Arguments
Two or more strings, string variables, lists, or matrices.
34
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
Notes
More than two arguments can be strung together. Each additional string is appended to the
end, in left to right order. Each additional matrix is appended in left to right order.
Example
a=&quot;Hello&quot;; b=&quot; &quot;; c=&quot;World&quot;; a||b||c;
&quot;Hello World&quot;
d={&quot;apples&quot;, &quot;bananas&quot;}; e={&quot;peaches&quot;, &quot;pears&quot;}; Concat(d,e);
{&quot;apples&quot;, &quot;bananas&quot;, &quot;peaches&quot;, &quot;pears&quot;}
A=[1 2 3]; B=[4 5 6]; Concat ( A, B );
[1 2 3 4 5 6]
Concat Items({string1, string2, ...}, &lt;delimiter&gt;})
Description
Converts a list of string expressions into one string, with each item separated by a delimiter.
The delimiter is a blank, if unspecified.
Returns
The concatenated string.
Arguments
string any string
delimiter an optional string that is placed between each item. The delimiter can be more
than one character long.
Example
str1 = &quot;one&quot;;
str2 = &quot;two&quot;;
str3 = &quot;three&quot;;
comb = concat Items ({str1, str2, str3});
&quot;one two three&quot;
comb = concat Items ({str1, str2, str3}, &quot; : &quot;);
&quot;one : two : three&quot;
del = &quot;,&quot;;
comb = concat Items ({str1, str2, str3}, del);
&quot;one,two,three&quot;
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
35
Concat To(a, b)
Concat To(a, b)
a||=b
A||=B
Description
For strings: Appends the string b to the string a and places the new concatenated string into
a.
For matrices: Appends the matrix b to the matrix a and places the new concatenated matrix
into a.
Returns
For strings: A string composed of the string a directly followed by the string b.
For matrices: A matrix.
Arguments
Two or more strings, string variables, or matrices. The first variable must be a variable
whose value can be changed.
Notes
More than two arguments can be strung together. Each additional string or matrix is
appended to the end, in left to right order.
Example
a =&quot;Hello&quot;; b=&quot; &quot;; c=&quot;World&quot;; Concat To(a, b, c); Show(a);
a = &quot;Hello World&quot;
A = [1 2 3]; B = [4 5 6]; Concat To(A, B); Show(A);
A = [1 2 3 4 5 6];
Contains(whole, part, &lt;start&gt;)
Description
Determines whether part is contained within whole.
Returns
If part is found: For lists, strings, and namespaces, the numeric position where the first
occurrence of part is located. For associative arrays, 1.
If part is not found, 0 is returned in all cases.
Arguments
whole A string, list, namespace, or associative array.
part For a string or namespace, a string that can be part of the string whole. For a list, an
item that can be an item in the list whole. For an associative array, a key that can be one
of the keys in the map whole.
36
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
start An optional numeric argument that specifies a starting point. within whole. If
start is negative, contains searches whole for part backwards, beginning with the
position specified by the length of whole – start. Note that start is meaningless for
associative arrays and is ignored.
Example
nameList={&quot;Katie&quot;, &quot;Louise&quot;, &quot;Jane&quot;, &quot;Jaclyn&quot;};
r = Contains(nameList, &quot;Katie&quot;);
The example returns a 1 because “Katie” is the first item in the list.
Ends With(string, substring)
Description
Determines whether substring appears at the end of string.
Returns
1 if string ends with substring, otherwise 0.
Arguments
string A quoted string or a string variable. Can also be a list.
substring A quoted string or a string variable. Can also be a list.
Equivalent Expression
Right(string, Length(substring)) == substring
Hex(value, &lt;&quot;integer&quot; | encoding=&quot;enc&quot;)
See “Char To Hex(value, &lt;ʺintegerʺ | ʺencodingʺ&gt;)” on page 32.
Hex To Blob(string)
Description
Converts the quoted hexadecimal string (including whitespace characters) to a blob
(binary large object).
Example
Hex To Blob(&quot;4A4D50&quot;);
Char To Blob(&quot;JMP&quot;, &quot;ascii~hex&quot;)
Hex To Char(string, &lt;encoding&gt;)
Description
Converts the quoted hexadecimal string to its character equivalent.
Example
Hex To Char (&quot;30&quot;) results in “0”.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
37
Notes
The default encoding supported for the hex code is utf‐8. You can also specify one of these
encodings: utf‐16le, utf‐16be, us‐ascii, iso‐8859‐1, ascii‐hex, shift‐jis, and euc‐jp.
Hex To Number(string)
Description
Converts the quoted hexadecimal string to its integer or its floating number equivalent.
Example
Hex To Number(&quot;80&quot;);
128
Note
16‐digit hexadecimal numbers are converted as IEEE 754 64‐bit floating point numbers.
Whitespace between bytes (or pairs of digits) and in the middle of bytes is permitted (for
example, FF 1919 and F F1919).
Insert(source, item, &lt;position&gt;)
Insert(source, key, value)
Description
Inserts a new item into the source at the given position. If position is not given, item is
added to the end.
For an associative array: Adds the key into the source associative array and assigns value
to it. If the key exists in source already, its value is overwritten with the new value.
Arguments
source A string, list, expression, or associative array.
item or key Any value to be placed within source. For an associative array, key might or
might not be present in source.
position Optional numeric value that specifies the position in source to place the item
into.
value A value to assign to the key.
Insert Into(source, item, &lt;position&gt;)
Insert Into(source, key, value)
Description
Inserts a new item into the source at the given position in place. The source must be an
L‐value.
Arguments
source A variable that contains a string, list, expression, or associative array.
38
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
item or key Any value to be placed within source. For an associative array, key might or
might not be present in source.
position Optional numeric value that specifies the position in source to place the item
into.
value A value to assign to the key.
Item(n, string, &lt;delimiters&gt;)
Description
Extracts the nth word from a quoted string according to the quoted string delimiters
given. The default delimiter is space. If you include a third argument, any and all characters
in that argument are taken to be delimiters.
Note
Item() is the same as Word() except that Item() treats each delimiter character as a
separate delimiter, and Word() treats several adjacent delimiters as a single delimiter.
Item(4,&quot;the
&quot;brown&quot;
Word(4,&quot;the
&quot;fox&quot;
quick brown fox&quot;);
quick brown fox&quot;);
Left(string, n, &lt;filler&gt;)
Left(list, n, &lt;filler&gt;)
Description
Returns a truncated or padded version of the original string or list. The result contains
the left n characters or list items, padded with any filler on the right if the length of
string is less than n.
Length(string)
Description
Calculates the number of characters (length) of the quoted string.
Lowercase(string)
Description
Converts any upper case character found in quoted string to the equivalent lowercase
character.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
39
Munger(string, offset, find|length)
Munger(string, offset, find, replace)
Description
Computes new character strings from the quoted string by inserting or deleting
characters. It can also produce substrings, calculate indexes, and perform other tasks
depending on how you specify its arguments.
Offset is a numeric expression indicating the starting position to search in the string. If the
offset is greater than the position of the first instance of the find argument, the first
instance is disregarded. If the offset is greater than the search string’s length, Munger uses
the string’s length as the offset.
Num(string)
Description
Converts a character string into a number.
Regex(&quot;source&quot;, &quot;pattern&quot;, (&lt;replacementString&gt;, &lt;GLOBALREPLACE&gt;),
&lt;format&gt;, &lt;IGNORECASE&gt;)
Description
Searches for the pattern within the source string.
Returns
The matched text as a string or numeric missing if there was no match.
Arguments
source A quoted string.
pattern A quoted regular expression.
format Optional. A backreference to the capturing group. The default is \0, which is the
entire matched string. \n returns the nth match.
IGNORECASE Optional. The search is case sensitive, unless you specify IGNORECASE.
GLOBALREPLACE Optional with a replacement string. Applies the regular expression to the
source string repeatedly until all matches are found.
40
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
Remove(source, position, &lt;n&gt;)
Remove(source, {items})
Remove(source, key)
Description
Deletes the n item(s), starting from the indicated position. If n is omitted, the item at
position is deleted. If position and n are omitted, the item at the end is removed. For an
associative array: Deletes the key and its value.
Returns
A copy of the source with the items deleted.
Arguments
source A string, list, expression, or associative array.
position or key An integer (or list of integers) that points to a specific item (or items) in
the list or expression.
n Optional. An integer that specifies how many items to remove.
Remove From(source, position, &lt;n&gt;)
Remove From(source, key)
Description
Deletes the n item(s) in place, starting from the indicated position. If n is omitted, the item
at position is deleted. If position and n are omitted, the item at the end is removed. For
an associative array: Deletes the key and its value. The source must be an L‐value.
Returns
The original source with the items deleted.
Arguments
source A string, list, expression, or associative array.
position or key An integer (or list of integers) that points to a specific item (or items) in
the list or expression.
n Optional. An integer that specifies how many items to remove.
Repeat(source, a)
Repeat(matrix, a, b)
Description
Returns a copy of source concatenated with itself a times. Or returns a matrix composed of
a row repeats and b column repeats. The source can be text, a matrix, or a list.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
41
Reverse(source)
Description
Reverse order of elements or terms in the source.
Argument
source A string, list, or expression.
Reverse Into(source)
Description
Reverse order of elements or terms in list or expr in place.
Argument
source A string, list, or expression.
Right(string, n, &lt;filler&gt;)
Right(list, n, &lt;filler&gt;)
Description
Returns a truncated or padded version of the original string or list. The result contains
the right n characters or list items, padded with any filler on the left if the length of
string is less than n.
Shift(source, &lt;n&gt;)
Description
Shifts an item or n items from the front to the back of the source.
Arguments
source A string, list, or expression.
n Optional. An integer that specifies the number of items to shift. Positive values shift
items from the beginning of the source to the end. Negative values shift items from the
end of the source to the beginning. The default value is 1.
Shift Into(source, &lt;n&gt;)
Description
Shifts items in place.
Arguments
source A string, list, or expression.
n Optional. An integer that specifies the number of items to shift. Positive values shift
items from the beginning of the source to the end. Negative values shift items from the
end of the source to the beginning. The default value is 1.
42
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
Starts With(string, substring)
Description
Determines whether substring appears at the start of string.
Returns
1 if string starts with substring, otherwise 0.
Arguments
string A quoted string or a reference to one. Can also be a list.
substring A quoted string or a reference to one. Can also be a list.
Equivalent Expression
Left(string, Length(substring)) = = substring
Substitute(string, substring, replacementString, ...)
Substitute(list, listItem, replacementItem, ...)
Substitute(Expr(sourceExpr), Expr(findExpr), Expr(replacementExpr), ...)
Description
This is a search and replace function. It searches for a specific portion (second argument) of
the source (first argument), and replaces it (third argument).
If a string, finds all matches to substring in the source string, and replaces them with the
replacementString.
If a list, finds all matches to listItem in the source list, and replaces them with the
replacementItem.
If an expression, finds all matches to the findExpr in the sourceExpr, and replaces them
with the replacementExpr. Note that all expressions must be enclosed within an Expr()
function.
Arguments
string, list, sourceExpr A string, list, or expression in which to perform the
substitution.
substring, listItem, findExpr A string, list item, or expression to be found in the
source string, list, or expression.
replacementString, replacementItem, replacementExpr A string, list item, or
expression to replace the found string, list item, or expression.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
43
Substitute Into(string, substring, replacementString, ...)
Substitute Into(list, listItem, replacementItem, ...)
Substitute Into(Expr(sourceExpr), Expr(findExpr), Expr(replacementExpr),
...)
Description
This is a search and replace function, identical to Substitute() except in place. It searches
for a specific portion (second argument) of the source (first argument), and replaces it (third
argument). The first argument must be an L‐value.
If a string, finds all matches to substring in the source string, and replaces them with the
replacementString.
If a list, finds all matches to listItem in the source list, and replaces them with the
replacementItem.
If an expression, finds all matches to the findExpr in the sourceExpr, and replaces them
with the replacementExpr. Note that all expressions must be enclosed within an Expr()
function.
Arguments
string, list, sourceExpr A string, list, or expression in which to perform the
substitution.
substring, listItem, findExpr A string, list item, or expression to be found in the
source string, list, or expression.
replacementString, replacementItem, replacementExpr A string, list item, or
expression to replace the found string, list item, or expression.
Substr(string, start, length)
Description
Extracts the characters that are the portion of the first argument beginning at the position
given by the second argument and ending based on the number of characters specified in
the third argument. The first argument can be a character column or value, or an expression
evaluating to same. The starting argument and the length argument can be numbers or
expressions that evaluate to numbers.
Example
This example extracts the first name:
Substr(&quot;Katie Layman&quot;, 1, 5);
The function starts at position 1, reads through position 5, and ignores the remaining
characters, which yields “Katie.”
44
JSL Functions
Character Functions
Chapter 2
JSL Syntax Reference
Titlecase(&quot;text&quot;)
Description
Converts the string to title case, that is, each word in the string has an initial uppercase
character and subsequent lowercase characters.
Returns
A quoted string.
Arguments
text A quoted string.
Example
For example, the following function:
Titlecase(&quot;veronica layman&quot;)
returns the following string:
&quot;Veronica Layman&quot;
Trim(&quot;text&quot;,&lt;left|right|both&gt;)
Trim Whitespace(&quot;text&quot;,&lt;left|right|both&gt;)
Description
Removes leading and trailing whitespace.
Results
A quoted string.
Arguments
text A quoted string.
left|right|both The second argument determines if whitespace is removed from the
left, the right, or both ends of the string. If no second argument is used, whitespace is
removed from both ends.
Example
For example, the following command:
Trim(&quot;
John
&quot;, both)
returns the following string:
&quot;John&quot;
Uppercase(string)
Description
Converts any lower case character found in the quoted string to the equivalent uppercase
character.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Functions
45
Word(n, &quot;text&quot;, &lt;&quot;delimiters&quot;&gt;)
Description
Extracts the nth word from a character string according to the delimiters given. The default
delimiter is space. If you include a third argument, any and all characters in that argument
are taken to be delimiters.
Examples
This example returns the last name:
Word(2, &quot;Katie Layman&quot;);
Note
Word() is the same as Item(), except that Item() treats each delimiter character as a
separate delimiter, and Word() treats several adjacent delimiters as a single delimiter.
Item(4,&quot;the
&quot;brown&quot;
Word(4,&quot;the
&quot;fox&quot;
quick brown fox&quot;);
quick brown fox&quot;);
Words(&quot;text&quot;, &lt;&quot;delimiters&quot;&gt;)
Description
Extracts the words from text according to the delimiters given. The default delimiter is
space. If you include a second argument, any and all characters in that argument are taken
to be delimiters.
Examples
Words(&quot;the quick brown fox&quot;);
{&quot;the&quot;,&quot;quick&quot;,&quot;brown&quot;,&quot;fox&quot;}
Words(&quot;Doe, Jane P.&quot;,&quot;, .&quot;);
{&quot;Doe&quot;,&quot;Jane&quot;,&quot;P&quot;}
XPath Query( xml, &quot;xpath_expression&quot;)
Description
Runs an XPath expression on an XML document.
Returns
A list.
Arguments
xml A valid XML document.
xpath_expression A quoted XPath 1.0 expression.
46
JSL Functions
Character Pattern Functions
Chapter 2
JSL Syntax Reference
Example
Suppose that you created a report of test results in JMP and exported important details to
an XML document. The test results are enclosed in &lt;result&gt; tags.
The following example stores the XML document in a variable. The XPath Query
expression parses the XML to find the text nodes inside the &lt;result&gt; tags. The results are
returned in a list.
rpt =
&quot;\[&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
&lt;JMP&gt;&lt;report&gt;&lt;title&gt;Production Report&lt;/title&gt;
&lt;result&gt;November 21st: Pass&lt;/result&gt;
&lt;result&gt;November 22nd: Fail&lt;/result&gt;
&lt;note&gt;Tests ran at 3:00 a.m.&lt;/note&gt;&lt;/report&gt;
&lt;/JMP&gt; ]\&quot;;
results = XPath Query( rpt, &quot;//result/text()&quot; );
{&quot;November 21st: Pass&quot;, &quot;November 22nd: Fail&quot;}
Character Pattern Functions
See the Pattern Matching section in the Scripting Guide book for more detailed information on
constructing and using pattern matching expressions.
Pat Abort()
Description
Constructs a pattern that immediately stops the pattern match. The matcher does not back
up and retry any alternatives. Conditional assignments are not made. Immediate
assignments that were already made are kept.
Returns
0 when a match is stopped.
Argument
none
Pat Altern(pattern1, &lt;pattern 2, ...&gt;)
Description
Constructs a pattern that matches any one of the pattern arguments.
Returns
A pattern.
Argument
One or more patterns.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Pattern Functions
47
Pat Any(&quot;string&quot;)
Description
Constructs a pattern that matches a single character in the argument.
Returns
A pattern.
Argument
string a string.
Pat Arb()
Description
Constructs a pattern that matches an arbitrary string. It initially matches the null string. It
then matches one additional character each time the pattern matcher backs into it.
Returns
A pattern.
Argument
none
Example
p = &quot;the beginning&quot; + Pat Arb() &gt;? stuffInTheMiddle + &quot;the end&quot;;
Pat Match(&quot;in the beginning of the story, and not near the end, there are
three bears&quot;, p);
show(stuffInTheMiddle);
stuffInTheMiddle = &quot; of the story, and not near &quot;
Pat Arb No(pattern)
Description
Constructs a pattern that matches zero or more copies of pattern.
Returns
A pattern.
Argument
pattern a pattern to match against.
Example
adjectives = &quot;large&quot; | &quot;medium&quot; | &quot;small&quot; | &quot;warm&quot; | &quot;cold&quot; | &quot;hot&quot; | &quot;sweet&quot;;
rc = Pat Match(&quot;I would like a medium hot, sweet tea please&quot;,
Pat Arbno(adjectives | Pat Any(&quot;, &quot;)) &gt;&gt; adj +
(&quot;tea&quot; | &quot;coffee&quot; | &quot;milk&quot;));
show(rc, adj);
rc = 1;
adj = &quot; medium hot, sweet &quot;;
48
JSL Functions
Character Pattern Functions
Chapter 2
JSL Syntax Reference
Pat At(varName)
Description
Constructs a pattern that matches the null string and stores the current position in the
source string into the specified JSL variable (varName). The assignment is immediate, and
the variable can be used with expr() to affect the remainder of the match.
Returns
A pattern.
Argument
varName the name of a variable to store the result in.
Example
p = &quot;:&quot; + Pat At(listStart) + expr(if(listStart==1, Pat Immediate(Pat Len(3),
early), Pat Immediate(Pat Len(2), late)));
early = &quot;&quot;; late = &quot;&quot;;
Pat Match(&quot;:123456789&quot;, p);
show(early,late); early = &quot;&quot;; late = &quot;&quot;;
Pat Match(&quot;
:123456789&quot;, p);
show(early,late);
First this is produced:
early = &quot;123&quot;
late = &quot;&quot;
and later this:
early = &quot;&quot;
late = &quot;12&quot;
Pat Break(&quot;string&quot;)
Description
Constructs a pattern that matches zero or more characters that are not in its argument; it
stops or breaks on a character in its argument. It fails if a character in its argument is not
found (in particular, it fails to match if it finds the end of the source string without finding a
break character).
Returns
A pattern.
Argument
string a string.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Pattern Functions
49
Pat Concat(pattern1, pattern2 &lt;pattern 3, ...&gt;)
Pattern1 + Pattern2 + ...
Description
Constructs a pattern that matches each pattern argument in turn.
Returns
A pattern.
Argument
Two or more patterns.
Pat Conditional(pattern, varName)
Description
Saves the result of the pattern match, if it succeeds, to a variable named as the second
argument (varName) after the match is finished.
Returns
A pattern.
Arguments
pattern a pattern to match against.
varName the name of a variable to store the result in.
Example
type = &quot;undefined&quot;;
rc = Pat Match(&quot;green apples&quot;, Pat Conditional(&quot;red&quot;|&quot;green&quot;, type) + &quot;
apples&quot;);
show(rc, type);
rc = 1;
type = &quot;green&quot;;
Pat Fail()
Description
Constructs a pattern that fails whenever the matcher attempts to move forward through it.
The matcher backs up and tries different alternatives. If and when there are no alternatives
left, the match fails and Pat Match returns 0.
Returns
0 when a match fails.
Argument
none
50
JSL Functions
Character Pattern Functions
Chapter 2
JSL Syntax Reference
Pat Fence()
Description
Constructs a pattern that succeeds and matches the null string when the matcher moves
forward through it, but fails when the matcher tries to back up through it. It is a one‐way
trap door that can be used to optimize some matches.
Returns
1 when the match succeeds, 0 otherwise.
Argument
none
Pat Immediate(pattern, varName)
Description
Saves the result of the pattern match to a variable named as the second argument (varName)
immediately.
Returns
A pattern.
Arguments
pattern a pattern to match against.
varName the name of a variable to store the result in.
Example
type = &quot;undefined&quot;;
rc = Pat Match(&quot;green apples&quot;, (&quot;red&quot;|&quot;green&quot;) &gt;&gt; type + &quot; pears&quot;);
show(rc, type);
rc = 0
type = &quot;green&quot;
Even though the match failed, the immediate assignment was made.
Pat Len(int)
Description
Constructs a pattern that matches n characters.
Returns
A pattern.
Argument
int an integer that specifies the number of characters.
Chapter 2
JSL Syntax Reference
JSL Functions
Character Pattern Functions
51
Pat Match(SourceText, Pattern, &lt;ReplacementText&gt;, &lt;NULL&gt;, &lt;ANCHOR&gt;,
&lt;MATCHCASE&gt;, &lt;FULLSCAN&gt;)
Description
Pat Match executes the Pattern against the SourceText. The pattern must be constructed
first, either inline or by assigning it to a JSL variable elsewhere.
Returns
1 if the pattern is found, 0 otherwise.
Arguments
SourceText A string or string variable that contains the text to be searched.
Pattern A pattern or pattern variable that contains the text to be searched for.
ReplacementText Optional string that defines text to replace the pattern in the source text.
NULL A placeholder for the third argument if ANCHOR, MATCHCASE, or FULLSCAN
are necessary and there is no replacement text.
ANCHOR Optional command to start the pattern match to the beginning of the string. The
following match fails because the pattern, “cream”, is not found at the beginning of the
string:
Pat Match( &quot;coffee with cream and sugar&quot;, &quot;cream&quot;, NULL, ANCHOR );
MATCHCASE Optional command to consider capitalization in the match. By default, Pat
Match() is case insensitive.
FULLSCAN Optional command to force Pat Match to try all alternatives, which uses more
memory as the match expands. By default, Pat Match() does not use FULLSCAN, and
makes some assumptions that allow the recursion to stop and the match to succeed.
Pat Not Any(&quot;string&quot;)
Description
Constructs a pattern that matches a single character that is not in the argument.
Returns
A pattern.
Argument
string a string.
Pat Pos(int)
Description
Constructs patterns that match the null string if the current position is int from the left end
of the string, and fail otherwise.
52
JSL Functions
Character Pattern Functions
Chapter 2
JSL Syntax Reference
Returns
A pattern.
Argument
int an integer that specifies a position in a string.
Pat R Pos(int)
Description
Constructs patterns that match the null string if the current position is int from the right
end of the string, and fails otherwise.
Returns
A pattern.
Argument
int an integer that specifies a position in a string.
Pat R Tab(int)
Description
Constructs a pattern that matches up to position n from the end of the string. It can match 0
or more characters. It fails if it would have to move backwards or beyond the end of the
string.
Returns
A pattern.
Argument
int an integer that specifies a position in a string.
Pat Regex(string)
Description
Constructs a pattern that matches the regular expression in the quoted string argument.
Returns
A pattern.
Argument
string a string.
Pat Rem()
Description
Constructs a pattern that matches the remainder of the string. It is equivalent to Pat R
Tab(0).
Chapter 2
JSL Syntax Reference
JSL Functions
Character Pattern Functions
53
Returns
A pattern.
Argument
none
Pat Repeat(pattern, minimum, maximum, GREEDY|RELUCTANT)
Description
Matches pattern between minimum and maximum times.
Returns
A pattern.
Arguments
pattern a pattern to match against.
minimum An integer that must be smaller than maximum.
maximum An integer that must be greater than minimum.
GREEDY|RELUCTANT If GREEDY is specified, it tries the maximum first and works back to the
minimum. If RELUCTANT is specified, it tries the minimum first and works up to the
maximum.
Notes
Pat Arbno(p) is the same as Pat Repeat(p, 0, infinity, RELUCTANT)
Pat Repeat(p) is the same as Pat Repeat(p, 1, infinity, GREEDY)
Pat Repeat(p, n) is the same as Pat Repeat(p, n, infinity, GREEDY)
Pat Repeat(p, n, m) is the same as Pat Repeat(p, n, m, GREEDY)
Pat Span(&quot;string&quot;)
Description
Constructs a pattern that matches one or more (not zero) occurrences of characters in its
argument. It is greedy; it always matches the longest possible string. It fails rather than
matching zero characters.
Returns
A pattern.
Argument
string a string.
Pat String(&quot;string&quot;)
Description
Constructs a pattern that matches its string argument.
54
JSL Functions
Character Pattern Functions
Chapter 2
JSL Syntax Reference
Returns
A pattern.
Argument
string a string.
Pat Succeed()
Description
Constructs a pattern that always succeeds, even when the matcher backs into it. It matches
the null string.
Returns
1 when the match succeeds.
Argument
none
Pat Tab(int)
Description
Constructs a pattern that matches forward to position int in the source string. It can match
0 or more characters. It fails if it would have to move backwards or beyond the end of the
string.
Returns
A pattern.
Argument
int an integer that specifies a position in a string.
Pat Test(expr)
Description
Constructs a pattern that succeeds and matches the null string if expr is not zero and fails
otherwise.
Returns
A pattern.
Argument
expr An expression.
Note
Usually the argument is wrapped with expr() because the test needs to be made on the
current value of variables set by Pat Immediate, Pat Conditional, and Pat At. Without
expr, the test is based on values that were known when the pattern was constructed, which
Chapter 2
JSL Syntax Reference
JSL Functions
Comment Functions
55
means the test always succeeds or always fails at pattern execution time, which is probably
not what you want.
Example
nCats = 0;
whichCat = 3;
string = &quot;catch a catnapping cat in a catsup factory&quot;;
rc = Pat Match(string, &quot;cat&quot; + Pat Test(expr(nCats=nCats+1; nCats ==
whichCat)), &quot;dog&quot;);
show(rc, string, nCats);
rc = 1
string = &quot;catch a catnapping dog in a catsup factory&quot;
nCats = 3
Regex Match(source, pattern, &lt;MATCHCASE&gt;)
Description
Executes the pattern match in pattern against the quoted source string.
Returns
A pattern.
Argument
source a string.
pattern a pattern.
MATCHCASE Optional. The search is case insensitive unless you specify MATCHCASE.
Comment Functions
// comment
Description
Comments to end of line.
Notes
Everything after the // is ignored when running the script.
/* comment */
Description
A comment that can appear in the middle of a line of script.
Notes
Anything between the beginning tag /* and the end tag */ is ignored when running the
script. This comment style can be used almost anywhere, even inside lists of arguments. If
56
JSL Functions
Comparison Functions
Chapter 2
JSL Syntax Reference
you place a comment inside a double‐quoted string, the comment is treated merely as part
of the string and not a comment. You cannot place comments in the middle of operators.
Examples
+/*comment*/=
:/*comment*/name
are invalid and produce errors. The first comment interrupts += and the second interrupts
:name.
sums = {(a+b /*comment*/), /*comment*/ (c^2)}
is valid JSL; the comments are both ignored.
//!
Description
If placed on the first line of a script, this comment line causes the script to be run when
opened in JMP without opening into the script editor window.
Notes
You can over‐ride this comment when opening the file. Select File &gt; Open. Hold the CTRL
key while you select the JSL file and click Open. Or right‐click the file in the Home Window
Recent Files list and select Edit Script. The script opens into a script window instead of
being executed.
/*debug step*/
/*debug run*/
Description
If placed on the first line of a script, the script is opened into the debugger when it is run.
Notes
All letters must be lower case. There must be one space between debug and step or run, and
there must be no other spaces present. Only one of these lines can be used, and it must be
the first line of the script; a first line that is blank followed by this comment negates the
debug command.
Comparison Functions
The comparison operators (&lt;, &lt;=, &gt;, &gt;=) work for numbers, strings, and matrices. For matrices,
they produce a matrix of results. If you compare mixed arguments, such as strings with
numbers or matrices, the result is a missing value. Comparisons involving lists are not
allowed and also return missing values.
Chapter 2
JSL Syntax Reference
JSL Functions
Comparison Functions
57
The equality operators (== and !=) work for numbers, strings, matrices, and lists. For matrices,
they produce a matrix of results; for lists, they produce a single result. If you test equality of
mixed results (for example. strings with numbers or matrices) the result is 0 or unequal.
Range check operators let you check whether something falls between two specified values:
a=1;show(1&lt;=a&lt;3);
b=2;show(2&lt;b&lt;=3);
1&lt;=a&lt;3 = 1
2&lt;b&lt;=3 = 0
Expressions with comparison operators are evaluated all at once, not in sequence
All the comparison operators are eliding operators. That means JMP treats arguments joined by
comparison operators as one big clause, as opposed to the way most expressions are evaluated
one operator at a time. Evaluating as a single clause produces different results than the more
usual method of evaluating in pieces. For example, the following two statements are different:
12&lt;a&lt;13;
(12&lt;a)&lt;13;
The first statement checks whether a is between 12 and 13, because all three arguments and
both operators are read and evaluated together. The second statement uses parentheses to
regroup the operations explicitly to evaluate from left to right, which would be the normal
way to evaluate most expressions. Thus it first checks whether 12 is less than a, returning 1 if
true or 0 if false. Then it checks whether the result is less than 13, which is always true because
0 and 1 are both less than 13.
All the comparison operators are elided when they are used in matched pairs or in the
unmatched pairs &lt;... &lt;= and &lt;=... &lt;. What this means is that if you want a comparison
statement to be evaluated one comparison operator at a time, you should use parentheses ( )
to control the order of operations explicitly.
Equal(a, b, ...)
a==b==...
Description
Compares all the listed values and tests if they are all equal to each other.
Returns
1 (true) if all arguments evaluate to the same value.
0 (false) otherwise.
Arguments
Two or more variables, references, matrices, or numbers.
58
JSL Functions
Comparison Functions
Chapter 2
JSL Syntax Reference
Notes
If more than two arguments are specified, a 1 is returned only if all arguments are exactly
the same. This is typically used in conditional statements and to control loops.
The comparison is case‐sensitive for string comparisons.
See Also
The Conditional Functions section of the Scripting Guide.
Greater(a, b, ...)
a&gt;b&gt;...
Description
Compares all the list values and tests if, in each pair, the left value is greater than the right.
Returns
1 (true) if a evaluates strictly greater than b (and b evaluates strictly greater than c, and so
on).
0 (false) otherwise.
Arguments
Two or more variables, references, matrices, or numbers.
Notes
If more than two arguments are specified, a 1 is returned only if each argument is greater
than the one that follows it. This is typically used in conditional statements and to control
loops.
Greater, Less, GreaterOrEqual, and LessOrEqual can also be strung together. If you do not
group with parentheses, JMP evaluates each pair left to right. You can also use parentheses
to explicitly tell JMP how to evaluate the expression.
See Also
The Conditional Functions section of the Scripting Guide.
Greater or Equal(a, b, ...)
a&gt;=b&gt;=...
Description
Compares all the list values and tests if, in each pair, the left value is greater than or equal to
the right.
Returns
1 (true) if a evaluates strictly greater than or equal to b (and b evaluates strictly greater than
or equal to c, and so on).
0 (false) otherwise.
Chapter 2
JSL Syntax Reference
JSL Functions
Comparison Functions
59
Arguments
Two or more variables, references, matrices, or numbers.
Notes
If more than two arguments are specified, a 1 is returned only if each argument is greater
than or equal to the one that follows it. This is typically used in conditional statements and
to control loops.
Greater, Less, GreaterOrEqual, and LessOrEqual can also be strung together. If you do not
group with parentheses, JMP evaluates each pair left to right. You can also use parentheses
to explicitly tell JMP how to evaluate the expression.
See Also
The Conditional Functions section of the Scripting Guide.
Is Missing(expr)
Description
Returns 1 if the expression yields a missing value and 0 otherwise.
Less(a, b, ...)
a&lt;b&lt;...
Description
Compares all the list values and tests if, in each pair, the left value is less than the right.
Returns
1 (true) if a evaluates strictly less than b (and b evaluates strictly less than c, and so on).
0 (false) otherwise.
Arguments
Two or more variables, references, matrices, or numbers.
Notes
If more than two arguments are specified, a 1 is returned only if each argument is less than
the one that follows it. This is typically used in conditional statements and to control loops.
Greater, Less, GreaterOrEqual, and LessOrEqual can also be strung together. If you do not
group with parentheses, JMP evaluates each pair left to right. You can also use parentheses
to explicitly tell JMP how to evaluate the expression.
See Also
The Conditional Functions section of the Scripting Guide.
60
JSL Functions
Comparison Functions
Chapter 2
JSL Syntax Reference
Less LessEqual(a, b, c, ...)
a&lt;b&lt;=c&lt;=...
Description
Range check, exclusive below and inclusive above.
Returns
1 (true) if b is greater than a and less than or equal to c.
0 (false) otherwise.
Arguments
a, b, c variables, references, matrices, or numbers.
Notes
Returns 1 when two conditions are met: the first argument is less than the second
argument, and each remaining argument is less than or equal to its argument on the right.
This is typically used in conditional statements and to control loops.
See Also
The Conditional Functions section of the Scripting Guide.
Less or Equal(a, b, ...)
a&lt;=b&lt;=...
Description
Compares all the list values and tests if, in each pair, the left value is less than or equal to
the right.
Returns
1 (true) if a evaluates strictly less than or equal to b (and b evaluates strictly less than or
equal to c, and so on).
0 (false) otherwise.
Arguments
Two or more variables, references, matrices, or numbers.
Notes
If more than two arguments are specified, a 1 is returned only if each argument is less than
or equal to the one that follows it. This is typically used in conditional statements and to
control loops.
Greater, Less, GreaterOrEqual, and LessOrEqual can also be strung together. If you do not
group with parentheses, JMP evaluates each pair left to right. You can also use parentheses
to explicitly tell JMP how to evaluate the expression.
See Also
The Conditional Functions section of the Scripting Guide.
Chapter 2
JSL Syntax Reference
JSL Functions
Comparison Functions
61
LessEqual Less(a, b, c, ...)
a&lt;=b&lt;c&lt;...
Description
Range check, inclusive below and exclusive above.
Returns
1 (true) if b is greater than or equal to a and less than c.
0 (false) otherwise.
Arguments
a, b, c variables, references, matrices, or numbers.
Notes
Returns 1 when two conditions are met: the first argument is less than or equal to the
second argument, and each remaining argument is less than its argument on the right. This
is typically used in conditional statements and to control loops.
See Also
The Conditional Functions section of the Scripting Guide.
Not Equal(a, b)
a!=b
Description
Compares a and b and tests if they are equal.
Returns
0 (false) if a and b evaluate to the same value.
1 (true) otherwise.
Argument
a, b Any variable or number.
Notes
Mostly used for conditional statements and loop control.
See Also
The Conditional Functions section of the Scripting Guide.
62
JSL Functions
Conditional and Logical Functions
Chapter 2
JSL Syntax Reference
Conditional and Logical Functions
And(a, b)
a&amp;b
Description
Logical And.
Returns
1 (true) if both a and b are true.
0 (false) if either a or b is false or if both a and b are false.
Missing if either a or b is a missing value or if both a and b are missing values.
Arguments
Two or more variables or expressions.
Notes
More than two arguments can be strung together. a&amp;b returns 1 (true) only if all arguments
evaluate to true.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
AndMZ(a, b)
AndV3(a, b)
a:&amp;b
Description
Logical And with JMP 3 behavior, which treats missing values as 0.
Returns
1 (true) if both a and b are true.
0 (false) if either a or b is false or if both a and b are false.
0 (false) if either a or b is a missing value or if both a and b are missing values.
Arguments
Two or more variables or expressions.
Notes
More than two arguments can be strung together. a:&amp;b returns 1 (true) only if all arguments
evaluate to true. When opening a JMP 3 data table, this function is automatically used for
any And function.
Chapter 2
JSL Syntax Reference
JSL Functions
Conditional and Logical Functions
63
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
Break()
Description
Stops execution of a loop completely and continues to the statement following the loop.
Note
Break works with For and While loops, and also with For Each Row.
Choose(expr, r1, r2, r3, ..., rElse)
Description
Evaluates expr. If the value of expr is 1, r1 is returned; if 2, the value of r2 is returned, and
so on. If no matches are found, the last argument (rElse) is returned.
Returns
The value whose index in the list of arguments matches expr, or the value of the last
argument.
Arguments
expr an expression or a value.
r1, r2, r3, ... an expression or a value.
Continue()
Description
Ends the current iteration of a loop and begins the loop at the next iteration.
Note
Continue works with For and While loops, and also with For Each Row.
For(init, while, increment, body)
Description
Repeats the statement(s) in the body as long as the while condition is true. Init and
increment control iterations.
Returns
Null.
Arguments
init Initialization of loop control counter.
while Condition for loop to continue or end. As long as the conditional statement while is
true, the loop is iterated one more time. As soon as while is false, the loop is exited.
64
JSL Functions
Conditional and Logical Functions
Chapter 2
JSL Syntax Reference
increment Increments (or decrements) the loop counter after while is evaluated every
time the loop is executed.
body Any number of valid JSL expressions, glued together if there are more than one.
Example
mysum = 0; myprod = 1;
For( i = 1, i &lt;= 10, i++, mysum += i; myprod *= i; );
Show( mysum, myprod );
mysum = 55;
myprod = 3628800;
For Each Row(&lt;dt,&gt; script)
Description
Repeats the script on each row of the data table.
Returns
Null.
Argument
dt Optional positional argument: a reference to a data table. If this argument is not in the
form of an assignment, then it is considered a data table expression.
script Any valid JSL expressions.
Example
The following example creates data table references and then iterates over each row in Big
Class.jmp. If the value of age in a row is greater than 15, the age is printed to the log.
dt1 = Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
dt2 = Open( &quot;$SAMPLE_DATA/San Francisco Crime.jmp&quot; );
For Each Row( dt1, If( :age &gt; 15, Show( :age ) ) );
If(condition, result, condition, ..., &lt;elseResult&gt;)
Description
Returns result when condition evaluates true. Otherwise returns next result when that
condition evaluates as true. The optional elseResult is used if none of the preceding
conditions are true. If no elseResult is given, and none of the conditions are true, then
nothing happens.
IfMax(expr1, result1, expr2, result2, ... &lt;all missing result&gt;)
Description
Evaluates the first of each pair of arguments and returns the evaluation of the result
expression (the second of each pair) associated with the maximum of the expressions. If
more than one expression is the maximum, the first maximum is returned. If all expressions
are missing and a final result is not specified, missing is returned. If all expressions are
Chapter 2
JSL Syntax Reference
JSL Functions
Conditional and Logical Functions
65
missing and a final result is specified, that final result is returned. The test expressions must
evaluate to numeric values, but the result expressions can be anything.
Returns
The result expression associated with the maximum of the expressions
IfMin(expr1, result1, expr2, result2, ... &lt;all missing result&gt;)
Description
Evaluates the first of each pair of arguments and returns the evaluation of the result
expression (the second of each pair) associated with the minimum of the expressions. If
more than one expression is the minimum, the first minimum is returned. If all expressions
are missing and a final result is not specified, missing is returned. If all expressions are
missing and a final result is specified, that final result is returned. The test expressions must
evaluate to numeric values, but the result expressions can be anything.
Returns
The result expression associated with the minimum of the expressions
IfMZ(condition, result, condition, ..., &lt;elseResult&gt;)
IfV3(condition, result, condition, ..., &lt;elseResult&gt;)
Description
Logical If with version 3.x behavior, which treats missing values as 0; used automatically
when opening v3 data tables.
Interpolate(x, x1, y1, x2, y2)
Interpolate(x, xmatrix, ymatrix)
Description
Linearly interpolates the y‐value corresponding to a given x‐value between two points (x1,
y1), and (x2, y2) or by matrices xmatrix and ymatrix. The points must be in ascending
order.
Is Associative Array(name)
Description
Returns 1 if the evaluated argument is an associative array, or 0 otherwise.
66
JSL Functions
Conditional and Logical Functions
Chapter 2
JSL Syntax Reference
Is Empty(global)
Is Empty(dt)
Is Empty(col)
Description
Returns 1 if the global variable, data table, or data column does not have a value (is
uninitialized), or 0 otherwise.
Is Expr(x)
Description
Returns 1 if the evaluated argument is an expression, or 0 otherwise.
Is List(x)
Description
Returns 1 if the evaluated argument is a list, or 0 otherwise.
Is Name(x)
Description
Returns 1 if the evaluated argument is a name, or 0 otherwise.
Is Namespace(namespace)
Description
Returns 1 if the namespace argument is a namespace; returns 0 otherwise.
Is Number(x)
Description
Returns 1 if the evaluated argument is a number or missing numeric value, or 0 otherwise.
Is Scriptable(x)
Description
Returns 1 if the evaluated argument is a scriptable object, or 0 otherwise.
Is String(x)
Description
Returns 1 if the evaluated argument is a string, or 0 otherwise.
Chapter 2
JSL Syntax Reference
JSL Functions
Conditional and Logical Functions
67
Match(a, value1, result1, value2, result2, ...)
Description
If a is equal to value1, then result1 is returned. If a is equal to value2, result2 is
returned, and so on.
MatchMZ(a, value1, result1, value2, result2, ...)
MatchV3(a, value1, result1, value2, result2, ...)
Description
Match with version 3.x behavior, which treats missing values as 0; used automatically when
opening v3 data tables.
Not(a)
!a
Description
Logical Not.
Returns
0 (false) if a&gt;0.
1 (true) if a&lt;=0.
Missing value if a is missing.
Argument
a Any variable or number. The variable must have a numeric or matrix value.
Notes
Mostly used for conditional statements and loop control.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
Or(a, b)
a|b
Description
Logical Or.
Returns
1 (true) if either of or both a and b are true.
0 (false) otherwise.
Missing if either are missing.
68
JSL Functions
Conditional and Logical Functions
Chapter 2
JSL Syntax Reference
Arguments
a, b Any variable or number.
Notes
Mostly used for conditional statements and loop control.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
OrMZ(a, b)
OrV3(a, b)
a :| b
Description
Logical Or with version 3.x behavior, which treats missing values as 0.
Returns
1 (true) if either of or both a and b are true.
0 (false) otherwise.
Arguments
a, b Any variable or number.
Notes
Mostly used for conditional statements and loop control. When opening a JMP 3 data table,
this function is automatically used for any Or function.
Or() returns missing if any evaluated argument is missing. OrMZ() returns 0 if any
evaluated argument is missing.
See Also
The Conditional Expressions and Loops section of the Scripting Guide.
Step(x, x1, y1, x2, y2, ...)
Description
Finds corresponding y for a given x from a step‐function fit. The points must be in
ascending order.
Stop()
Description
Immediately stops a script that is running.
Chapter 2
JSL Syntax Reference
JSL Functions
Constant
69
While(expr, body)
Description
Repeatedly tests the expr condition and executes the body until the expr is no longer true.
Zero Or Missing(expr)
Description
Returns 1 if expr yields a missing value or zero, 0 otherwise.
Constant
JMP provides functions for two useful constants.
Note: These functions do not take an argument, but the parentheses are required.
e()
Description
Returns the constant e, which is 2.7182818284590451...
Pi( )
Description
Returns the constant , which is 3.1415926535897931...
Date and Time Functions
Datetime values are handled internally as numbers of seconds since midnight, January 1,
1904.
The expression x=01Jan1904 sets x to zero, since the indicated date is the base date or “zero
date” in JMP. If you examine the values of dates, they should be appropriately large numbers.
For example 5oct1998 is 2990390400.
Abbrev Date(date)
Description
Converts the provided date to a string.
Returns
A string representation of the date.
70
JSL Functions
Date and Time Functions
Chapter 2
JSL Syntax Reference
Argument
date Can be the number of seconds since the base date (midnight, January 1, 1904), or any
date‐time operator.
Example
Abbrev Date(29Feb2004)
02/29/2004
See Also
Section on Date‐Time formats in the Scripting Guide.
As Date(x)
Description
Formats the number or expression x so that it shows as a date or duration when displayed
in a text window. Values that represent one year or more are returned as dates. Values that
represent less than a year are returned as durations.
Returns
A date that is calculated from the number or expression provided.
Argument
x Number or expression.
See Also
Section on Date‐Time formats in the Scripting Guide.
Date Difference(datetime1, datetime2, &quot;interval_name&quot;, &lt;&quot;alignment&quot;&gt;)
Description
Returns the difference in intervals of two date‐time values.
Returns
A number.
Arguments
datetime1, datetime2 Datetime values.
interval_name A quoted string that contains a date‐time interval, such as &quot;Month&quot;,
&quot;Day&quot;, or &quot;Hour&quot;.
alignment An optional string. Options are as follows:
‒ &quot;start&quot; counts the number of times the interval starts.
‒ &quot;actual&quot; counts whole intervals.
‒ &quot;fractional&quot; counts fractional intervals.
Chapter 2
JSL Syntax Reference
JSL Functions
Date and Time Functions
71
Date DMY(day, month, year)
Description
Constructs a date value from the arguments.
Returns
The specified date, expressed as the number of seconds since midnight, 1 January 1904.
Arguments
day number, day of month, 1‐31. Note that there is no error‐checking, so you can enter
February 31.
month number of month, 1‐12.
year number of year.
Date Increment(datetime, &quot;interval&quot;, &lt;increment&gt;, &lt;&quot;alignment&quot;&gt;)
Description
Adds 1 or more intervals to a starting datetime value.
Returns
Returns the new datetime value.
Arguments
datetime The starting datetime value.
interval A quoted string that contains the name of a datetime interval. For example,
&quot;Month&quot;, &quot;Day&quot; or &quot;Hour&quot;.
increment An optional number that specifies the number of intervals. The default value is
1.
alignment An optional quoted string that contains a keyword:
‒ &quot;start&quot; truncates lesser field values.
‒ &quot;actual&quot; keeps the lesser field values.
‒ &quot;fractional&quot; honor fractional increment values.
Date MDY(month, day, year)
Description
Constructs a date value from the arguments.
Returns
The specified date, expressed as the number of seconds since midnight, 1 January 1904.
Arguments
month number of month, 1‐12.
72
JSL Functions
Date and Time Functions
Chapter 2
JSL Syntax Reference
day number, day of month, 1‐31. Note that there is no error‐checking, so you can enter
February 31.
year number of year.
Day(datetime)
Description
Determine the day of the month supplied by the datetime argument.
Returns
Returns an integer representation for the day of the month of the date supplied.
Arguments
datetime Number of seconds since midnight, 1 January 1904. This can also be an
expression.
Example
d1=datedmy(12, 2, 2003);
3127852800
day(3127852800);
12
day(d1);
12
Day Of Week(datetime)
Description
Determine the day of the week supplied by the datetime argument.
Returns
Returns an integer representation for the day of the week of the date supplied.
Arguments
datetime Number of seconds since midnight, 1 January 1904. This can also be an
expression.
Day Of Year(datetime)
Description
Determine the day of the year supplied by the datetime argument.
Returns
Returns an integer representation for the day of the year of the date supplied.
Arguments
datetime Number of seconds since midnight, 1 January 1904. This can also be an
expression.
Chapter 2
JSL Syntax Reference
JSL Functions
Date and Time Functions
73
Format(x, &quot;format&quot;, &lt;&quot;currency code&quot;&gt;, &lt;decimal&gt;)
Format Date(x, &quot;format&quot;, &lt;&quot;currency code&quot;&gt;, &lt;decimal&gt;)
Description
Converts the value of date into the ʺformatʺ that you specify in the second argument.
Typically used for formatting datetime values from a number of seconds to a formatted
date. Format choices are those shown in the data table column properties.
Returns
Returns the converted date in the format specified.
Arguments
x Can be a column, a number, or a datetime.
format Any valid format, as a quoted string: &quot;Best&quot;, &quot;Fixed Decimal&quot;, &quot;Percent&quot;,
&quot;PValue&quot;, &quot;Scientific&quot;, &quot;Currency&quot;, or any of the Date/Time formats.
currency code An optional ISO 4217 code for a specific currency (for example, &quot;GBP&quot; for
Great Britain, Pound). This argument is valid only if Currency is specified as format.
decimal An optional integer that specifies the number of decimal places to be shown.
Hour(datetime, &lt;12|24&gt;)
Description
Determines the hour supplied by the datetime argument.
Returns
Returns an integer representation for the hour part of the date‐time value supplied.
Arguments
datetime Number of seconds since midnight, 1 January 1904. This can also be an
expression.
12|24 Changes the mode to 12 hours (with am and pm). The default is 24‐hour mode.
HP Time()
Description
Returns a high precision time value (in microseconds). This function is only useful relative
to another HP Time() value. The time value represents the number of microseconds since
the start of the JMP session.
Note
For less precise time values use Tick Seconds().
74
JSL Functions
Date and Time Functions
Chapter 2
JSL Syntax Reference
In Days(n)
Description
Returns the number of seconds per n days. Divide by this function to express seconds as
days.
In Format(string, &quot;format&quot;)
Parse Date(string, &quot;format&quot;)
Description
Parses a string of a given &quot;format&quot; and returns a date/time value. The value is expressed
as if surrounded by the As Date() function, returning the date in ʺddMonyyyyʺ format.
Format choices are those shown in the data table column properties. See “Utility Functions”
on page 249 for details on As Date.
Example
Informat(&quot;07152000&quot;, &quot;MMDDYYYY&quot;)
15Jul2000
In Hours(n)
Description
Returns the number of seconds per n hours. Divide by this function to express seconds as
hours.
In Minutes(n)
Description
Returns the number of seconds per n minutes. Divide by this function to express seconds as
minutes.
In Weeks(n)
Description
Returns the number of seconds per n weeks. Divide by this function to express seconds as
weeks.
In Years(n)
Description
Returns the number of seconds per n years. Divide by this function to express seconds as
years.
Chapter 2
JSL Syntax Reference
JSL Functions
Date and Time Functions
75
Long Date(date)
Description
Returns a locale‐specific string representation for the date supplied, formatted like
&quot;Sunday, February 29, 2004&quot; or &quot;Wednesday, November 9, 2011&quot;.
MDYHMS(date)
Description
Returns a string representation for the date supplied, formatted like &quot;2/29/04 00:02:20&quot;.
Minute(datetime)
Description
Determines the minute supplied by the datetime argument, 0‐59.
Returns
Returns an integer representation for the minute part of the date‐time value supplied.
Month(date)
Description
Returns an integer representation for the month of the date supplied.
Parse Date()
See “In Format(string, ʺformatʺ)” on page 74.
Quarter(datetime)
Description
Returns the annual quarter of a datetime value as an integer 1‐4.
Second(datetime)
Description
Determines the second supplied by the datetime argument.
Returns
Returns an integer representation for the second part of the date‐time value supplied.
Argument
datetime Number of seconds since midnight, 1 January 1904. This can also be an
expression.
76
JSL Functions
Date and Time Functions
Chapter 2
JSL Syntax Reference
Short Date(date)
Description
Returns a string representation for the date supplied, in the format mm/dd/yy. For
example, &quot;2/29/04&quot; for the next Leap Day.
Tick Seconds()
Description
Measures the time taken for a script to run, measured down to the 60th of a second.
Note
For higher time value resolution (for example, microseconds) use the HP Time() function.
Time Of Day(datetime)
Description
Returns an integer representation for the time of day of the datetime supplied.
Today()
Description
Returns the current date and time expressed as the number of seconds since midnight, 1
January 1904. No arguments are available, but the parentheses are still necessary.
Week Of Year(date, &lt;rule_n&gt;)
Description
Returns the week of the year that contains a date‐time value. Three rules determine when
the first week of the year begins.
‒ With rule 1 (the default), weeks start on Sunday, with the first Sunday of the year being
week 2. Week 1 is a partial week or empty.
‒ With rule 2, the first Sunday begins with week 1, with previous days being week 0.
‒ With rule 3, the ISO‐8601 week number is returned. Weeks start on Monday. Week 1 is
the first week of the year with four days in that year. It is possible for the first or last
three days of the year to belong to the neighboring year’s week number.
Year(date)
Description
Returns an integer representation for the year of date.
Chapter 2
JSL Syntax Reference
JSL Functions
Discrete Probability Functions
77
Discrete Probability Functions
Beta Binomial Distribution(k, p, n, delta)
Description
Returns the probability that a beta binomially distributed random variable is less than or
equal to k.
Beta Binomial Probability(k, p, n, delta)
Description
Returns the probability that a beta binomially distributed random variable is equal to k.
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.
Binomial Distribution(p, n, k)
Description
The probability that a binomially distributed random variable is less than or equal to k.
Returns
The cdf for the binomial distribution with n trials, probability p of success for each trial, and
k successes.
Arguments
p probability of success for each trial
n number of trials
k number of successes
See Also
The section on probability functions in the Using JMP.
Binomial Probability(p, n, k)
Description
The probability that a binomially distributed random variable is equal to k.
Returns
The probability of getting k successes out of n trials if the probability is p.
78
JSL Functions
Discrete Probability Functions
Chapter 2
JSL Syntax Reference
Arguments
p probability of success for each trial
n number of trials
k number of successes
See Also
The section on probability functions in the Using JMP.
Binomial Quantile(p, n, cumprob)
Description
The quantile function of binomial distribution.
Returns
The smallest integer quantile for which the cumulative probability of the Binomial(p, n)
distribution is larger than or equal to cumprob.
Arguments
p probability of success for each trial
n number of trials
cumprob cumulative probability
Gamma Poisson Distribution(k, lambda, sigma)
Description
Returns the probability that a gamma‐Poisson distributed random variable is less than or
equal to k.
Arguments
k The count of interest.
lambda The mean argument.
sigma The overdispersion argument.
Gamma Poisson Probability(k, lambda, sigma)
Description
Returns the probability that a gamma‐Poisson distributed random variable is equal to k.
Arguments
k The count of interest.
lambda The mean argument.
sigma The overdispersion argument.
Chapter 2
JSL Syntax Reference
JSL Functions
Discrete Probability Functions
79
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.
Hypergeometric Distribution(N, K, n, x, &lt;r&gt;)
Description
Returns the cumulative distribution function at x for the hypergeometric distribution with
population size N, K items in the category of interest, sample size n, count of interest x, and
optional odds ratio r.
Hypergeometric Probability(N, k, n, x, &lt;r&gt;)
Description
Returns the probability that a hypergeometrically distributed random variable is equal to x.
Arguments
pop Population size.
k The Number of items in the category of interest.
n Sample size.
x Count of interest.
r Optional odds ratio.
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.
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.
Poisson Distribution(lambda, k)
Description
Returns the cumulative distribution function at k for the Poisson distribution with mean
lambda.
80
JSL Functions
Display
Chapter 2
JSL Syntax Reference
Poisson Probability(lambda, k)
Description
Returns the probability that a Poisson distributed random variable with mean lambda is
equal to k.
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.
Display
Alpha Shape(Triangulation)
Description
Returns the alpha shape for the given triangulation.
Border Box(&lt;Left(pix)&gt;, &lt;Right(pix)&gt;, &lt;Top(Pix)&gt;, &lt;Bottom(Pix)&gt;,
&lt;Sides(0)&gt;, db)
Description
Constructs a bordered display box that contains another display box. Optional arguments
(Left, Right, Top, Bottom) add space between the border box and what it contains. The
other optional argument (Sides) draws borders around the border box on any single side or
combination of sides; draws the border in black or the highlight color; makes the
background transparent or white or erases the background of a display box that contains it.
Returns
The display box.
Arguments
Left An integer that measures pixels.
Right An integer that measures pixels.
Top An integer that measures pixels.
Bottom An integer that measures pixels.
Sides An integer that maps to settings for the display box.
db a display box object (for example, a text box or another border box).
Notes
The formula for deriving the integer for Sides is: 1*top + 2*left + 4*bottom + 8*right +
16*highlightcolor + 32*whitebackground + 64*erase. Thus, if you want to just draw a black
Chapter 2
JSL Syntax Reference
JSL Functions
Display
81
border on the top and bottom, 1+4 = 5. If you want that same box with a white background,
5+32 = 37.
Button Box(&quot;title&quot;, &lt;&lt;Set Icon(&quot;path&quot;), &quot;script&quot; &lt;&lt;Set Icon Location(&quot;left,
&quot;right&quot;)
Description
Constructs a button with the text title that executes script when clicked.
Returns
The display box (button box).
Arguments
title a quoted string or a string variable.
script a quoted string or a reference to a string where the string is a valid JSL script.
&lt;&lt;Set Icon(&quot;path&quot;) Displays the image in the pathname on the button. Most common
graphic formats are supported, such as GIF, JPG, PNG, BMP, TIF. Since the title
argument is optional, you can create a button with only a text title, with only an icon, or
with both a text title and an icon. In the last case, the icon is placed next to the text title.
&lt;&lt;Set Icon Location(&quot;right&quot; or &quot;left&quot;) Allows the position of the icon on a button
to be either left or right of the text.
Notes
Line‐break characters are ignored in button boxes.
Check Box(list, &lt;script&gt;)
Description
Constructs a display box to show one or more check boxes.
Returns
The display box (Check Box).
Arguments
list a list of quoted strings or a reference to a list of strings.
script an optional JSL script.
Messages
&lt;&lt;Get(n) Returns 1 if the check box item specified by n is selected, or 0 otherwise.
&lt;&lt;Set(n, 0|1) Sets the check box item specified by n as either selected (1) or cleared (0).
&lt;&lt;Get Selected Returns a list of strings that contain the names of the check box items
that are selected.
&lt;&lt;Enable Item(n, 0|1) Sets the check box item specified by n as either enabled (1) or
disabled (0). The state of a disabled check box cannot be changed.
82
JSL Functions
Display
Chapter 2
JSL Syntax Reference
&lt;&lt;Item Enabled(check box item) Returns 0 or 1 depending on whether the specific
check box item is enabled.
Example
Create three check boxes labeled “one”, “two”, and “three”. The first check box is selected.
Check Box({&quot;one&quot;, &quot;two&quot;, &quot;three&quot;}, &lt;&lt;set(1, 1))
Col List Box(&lt;&quot;all&quot;|&quot;character&quot;|&quot;numeric&quot;&gt;, &lt;width(pixels)&gt;,
&lt;maxSelected(n)&gt;, &lt;nlines(n)&gt;, &lt;MaxItems(n)&gt;, &lt;MinItems(n)&gt;, &lt;On
Change(expr)&gt;,&lt;script&gt;)
Description
Constructs a display box to show a list box that allows selection of data table columns.
Returns
The display box (ColListBox).
Arguments
all | character | numeric an optional command that adds all columns of the current
data table into the list. Omitting ʺallʺ results in an empty collistbox with the “optional”
label. To display “optional character”, specify ʺcharacterʺ. To display “optional
numeric”, specify ʺnumericʺ.
width(pixels) an optional command that sets the width of the list box to pix. pix is a
number that measures pixels.
maxSelected(n) an optional command that sets whether only one item can be selected.
For n&gt;1, n is ignored.
nlines(n) an optional command that sets the length of the list box to n number of lines. n
is an integer.
script an optional script.
MaxItems(n) An optional number that only allows n columns to be added to the list.
MinItems(n) An optional number that only requires at least n columns for the list. If n=2,
the top two slots in the Col List Box an initial display of “required numeric” (or
whatever you set the data type to be).
On Change(expression) An optional command that evaluates the expression each time
the contents of the column list box changes. Dragging between two column list boxes
that have this argument results in both expressions being evaluated. The expression for
the target being dragged is evaluated first, then the expression for the source is
evaluated.
Messages
&lt;&lt; Set Tips ( {&quot;Tip text 1&quot;, &quot;Tip text 2&quot;, ...} ) Sets tool tips for items in the
list box. A null string or an empty list results in no tips. A list shorter that the list of items
in the list box will use the last tip text for the remaining items in the list and the list box.
Chapter 2
JSL Syntax Reference
JSL Functions
Display
83
&lt;&lt; Set Tip ( &quot;Tip text&quot; ) Overrides any tool tips set using Set Tips() function. If
there is a tip set for the box, you cannot set tips for each individual item.
Using Set Tip() with no arguments clears the list box tip and allows the individual item
tool tips to be displayed.
Note
The maxSelected argument only affects whether one or more than one item can be selected.
It does not enforce a limit greater than 1.
Column Dialog(ColList(&quot;rolename&quot;), specifications)
Description
Draws a dialog box for column role assignments.
Returns
A list of commands that were sent and the button that was clicked.
Arguments
ColList Specifies the name of at list one list to add variables to.
specifications Any additional Dialog items (for example, Max Col, Datatype).
Combo Box(list, &lt;script&gt;)
Description
Constructs a display box to show a combo box with a menu.
Returns
The display box (ComboBox).
Arguments
list a list of quoted strings or a reference to a list of strings.
script an optional JSL script.
Context Box(displayBox, ...)
Description
Defines a scoped evaluation context. Each Context Box is executed independently of each
other.
Returns
A display box.
Arguments
Any number of display boxes.
84
JSL Functions
Display
Chapter 2
JSL Syntax Reference
Current Journal()
Description
Gets the display box at the top of the current (topmost) journal.
Returns
Returns a reference to the display box at the top of the current journal.
Current Report()
Description
Gets the display box at the top of the current (topmost) report window.
Returns
Returns a reference to the display box at the top of the current report window.
Current Window()
Description
Returns a reference to the current window.
Dialog(contents)
Dialog is deprecated. Use New Window() with the Modal argument instead. See the Scripting
Guide for details.
Excerpt Box(report, subscripts)
Description
Returns a display box containing the excerpt designated by the report held at number
report and the list of display subscripts subscripts. The subscripts reflect the current
state of the report, after previous excerpts have been removed.
Expr As Picture(expr(...), &lt;width(pixels)&gt;)
Description
Converts expr() to a picture as it would appear in the Formula Editor.
Returns
Reference to the picture.
Argument
expr(...) Place any valid JSL expression that can be displayed as a picture inside expr().
width(pixels) an optional command that sets the width of the box to pix. pix is a
number that measures pixels.
Chapter 2
JSL Syntax Reference
JSL Functions
Display
Filter Col Selector(&lt;data table(name)&gt;, &lt;width(pixels)&gt;, &lt;Nlines(n)&gt;,
&lt;script&gt;, &lt;OnChange(expr)&gt;)
Description
Returns a display box that contains a list of items. Control allows column filtering.
Global Box(global)
Description
Constructs a box for editing global value directly.
Graph()
See “Graph Box(properties, script)” on page 85.
Graph 3D Box(properties)
Description
Constructs a display box with 3‐D content.
Returns
The display box.
Arguments
Properties can include: framesize(x, y), Xname(&quot;title&quot;), Yname(&quot;title&quot;),
Zname(&quot;title&quot;).
Note
This display box constructor is experimental.
Graph Box(properties, script)
Graph(properties, script)
Description
Constructs a graph with axes.
Returns
The display box (Graph Box).
Arguments
properties Named property arguments: title(&quot;title&quot;), XScale(low, high),
YScale(low, high), FrameSize(h, v), XName(&quot;x&quot;), YName(&quot;y&quot;), DoubleBufer,
SuppressAxes.
script Any script to be run on the graph box.
85
86
JSL Functions
Display
Chapter 2
JSL Syntax Reference
H Center Box(display box)
Description
Returns a display box with the display box argument centered horizontally with respect to
all other sibling display boxes.
H List Box(&lt;Align(&quot;bottom&quot;|&quot;center&quot;)&gt;, display box, &lt;arguments&gt;)
Description
Creates a display box that contains other display boxes and displays them horizontally.
Boxes are bottom aligned by default.
H Sheet Box(&lt;&lt;Hold(report), display boxes)
Description
Returns a display box that arranges the display boxes provided by the arguments in a
horizontal layout. The &lt;&lt;Hold() message tells the sheet to own the report(s) that is
excerpted.
H Splitter Box(&lt;size(h,v)&gt;, display box, &lt;arguments&gt;)
Description
Returns a display box that arranges the display boxes provided by the arguments in a
horizontal layout (or panel). The splitter enables the user to interactively resize the panel.
Arguments
display box Any number of display box arguments can be contained in the splitter box.
Optional Arguments
size(h,v) Specifies the size of the splitter box in pixels. This size is for the outer splitter
box. Inner display boxes are proportionately sized according to the width and height of
the outer splitter box.
&lt;&lt;Size(n) Specifies the proportions of the last panel. &lt;&lt;Size(.25) resizes the last panel to
25% the splitter box height (or width, for vertical splitter boxes).
&lt;&lt;Set Sizes({n,n}) Specifies the proportions of each panel. db&lt;&lt;Sizes({.75, .25})
sizes the first panel to 75% and the second panel to 25% of the splitter box height (or
width, for vertical splitter boxes).
&lt;&lt;Close Panel(n, &lt;Boolean&gt;) Closes the panel that you specify. &lt;&lt;Close Panel(2)
closes the second panel. With three or more panels, you must include the second Boolean
value. That value indicates which panel expands to fill the space left by the closed panel.
‒ &lt;&lt;Close Panel(2,0) closes the second panel; the following sibling takes the extra
space.
Chapter 2
JSL Syntax Reference
87
JSL Functions
Display
‒ &lt;&lt;Close Panel(2,1) closes the second panel; the preceding sibling takes the extra
space.
&lt;&lt;Open Panel(n, &lt;Boolean&gt;) Opens the panel that you specify. With three or more
panels, you must include the second Boolean value. Works similar to &lt;&lt;Close Panel
described above. The panels are initially opened. You use &lt;&lt;Open Panel only after using
&lt;&lt;Close Panel.
&lt;&lt;Get Sizes() Returns the proportions of each panel as a list.
Hier Box(&quot;text&quot;, Hier Box(...), ...)
Description
Constructs a node of a tree (similar to Diagram output) containing text. Hier Box can
contain additional Hier Boxes, allowing you to create a tree. The text can be a Text Edit
Box.
Icon Box(&quot;name&quot;)
Description
Constructs a display box containing an icon, where the argument is a name such as
Popup
Nominal
, Locked
, Labeled
, or Ordinal
, Sub
, Excluded
, Hidden
, Continuous
,
. The argument can also be a path to animage.
Argument
name Quoted string that is the name of a JMP icon or the path to an icon.
Example
Icon Box(&quot;Nominal&quot;) constructs a display box that contains the Nominal icon.
Icon Box( &quot;$SAMPLE_IMAGES/pi.gif&quot; ) inserts the pi.gif sample image.
If Box(Boolean, display boxes)
Description
Constructs a display box whose contents are conditionally displayed.
Arguments
Boolean 1 displays the display boxes inside the If Box; if 0, does not display them.
display boxes Any display box tree.
Journal Box(&quot;Journal Text&quot;)
Description
Constructs a display box that displays the quoted string journal box. We recommend that
you do not generate the journal text by hand.
88
JSL Functions
Display
Chapter 2
JSL Syntax Reference
Line Seg(x, y, &lt;row states(dt, [rows] | dt, {rows} | {rowstates} |
[rowstates] | dt, {{rows}, {rows}, ...})&gt;)
Description
Creates a display seg of connected line segments. The optional third argument enables row
state assignments from either a data table or independently.
Lineup Box(&lt;NCol(n)&gt;, &lt;Spacing(pixels, &lt;vspace&gt;), display boxes, ...)
Description
Constructs a display box to show an alignment of boxes in n columns.
List Box({&quot;item&quot;, ...}, &lt;width(pixels)&gt;, &lt;maxSelected(n)&gt;, &lt;nLines(n)&gt;,
&lt;script&gt;)
Description
Creates a display box to show a list box of selection items. The argument can be a list of
two‐item lists containing the item name and a string that specifies the modeling type or
sorting order. The icon appears next to the corresponding item in the list box.
Matrix Box(matrix)
Description
Displays the matrix given in the usual array form.
Mouse Box(displayBoxArgs, messages)
Description
Returns a box that can make JSL callbacks for dragging and dropping, marking, or clicking
and tracking mouse actions.
Arguments
displayBoxArgs Specifies the object that the user interacts with, such as a Text Box or
Button Box. See the JMP Scripting Index for details.
Chapter 2
JSL Syntax Reference
JSL Functions
Display
89
New Image()
New Image(width, height)
New Image(&quot;filepath&quot;)
New Image(picture)
New Image(matrix)
New Image(&quot;rgb&quot;|&quot;r&quot;|&quot;rgba&quot;, {matrix, ...})
Description
Creates a new image in a report. PNG, JPG, GIF, BMP, or TIF file types are supported.
Returns
An image.
Arguments
All argument sets are optional, but all arguments within each set are required.
width, height Sets the width and height of the image in pixels.
&quot;filepath&quot; A filepath to an image.
picture A JSL picture object.
matrix The image as a matrix of JSL color pixels.
&quot;rgb&quot;|&quot;r&quot;|&quot;rgba&quot;, {matrix, ...} Specify the channels (rgb, r, or rgba) and provide a
matrix of values (0.0‐1.0) for each channel. Examples:
New Image(&quot;r&quot;, [r matrix]);
New Image(&quot;rgb&quot;, {[r matrix], [g matrix], [b matrix]};
New Image(&quot;rgba&quot;, {[r matrix], [g matrix], [b matrix], [a matrix]});
New Window(&quot;title&quot;, &lt;arguments&gt;, displayBox)
Description
Makes a new window with the indicated title (a required argument) and a display box tree.
Additional Arguments
&lt;&lt;Script(&lt;&quot;script&quot;&gt;) Creates a new script window. The optional quoted string script
is placed inside the script window.
&lt;&lt;Journal Creates an empty journal.
&lt;&lt;Size(x, y) Creates a new window of the specified height and width.
&lt;&lt;Modal Makes the new window a modal window, which prevents any other actions in
JMP until the window is closed. If you do not include an OK or Cancel button, one is
added automatically for you. Note: If used, this argument must be the second argument,
directly after the window title. Available modal window arguments are:
90
JSL Functions
Display
Chapter 2
JSL Syntax Reference
‒ On Open(expr) runs expr when the window is created. On Open (or OnOpen) scripts
that execute other programs are never run. Set the Evaluate OnOpen Scripts preference
to control when the script is run.
‒ On Close (expr) runs expr when the window is closed. Returns 0 if the window fails
to close.
‒ On Validate (expr) runs expr when the OK button is pressed. If it 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.
Show Toolbars(0|1) Show or hide the toolbar. The default value is 1. (Windows only.)
Show Menu(0|1) Show or hide the menu bar. The default value is 1. (Windows only.)
Suppress AutoHide Suppress or use the auto‐hide feature for menus and toolbars. The
default value is 1. (Windows only).
Notes
Dialog() was deprecated in JMP 10. Use New Window() with the Modal argument instead.
See the Modal Windows section in the Scripting Guide book for details on using
New Window().
Number Col Box(&quot;title&quot;, numbers)
Description
Creates a column named title with numeric entries given in list or matrix form.
Number Col Edit Box(&quot;title&quot;, numbers)
Description
Creates a column named title with numeric entries given in list or matrix form. The
numbers can be edited.
Number Edit Box(value)
Description
Creates an editable number box that initially contains the value argument.
Returns
The display box object.
Argument
value Any number.
Chapter 2
JSL Syntax Reference
JSL Functions
Display
91
Outline Box(&quot;title&quot;, display box, ...)
Description
Creates a new outline named title containing the listed display boxes.
Page Break Box()
Description
Creates a display box that forces a page break when the window is printed.
Panel Box(&quot;title&quot;, display box)
Description
Creates a display box labeled with the quoted string title that contains the listed display
boxes.
Picture Box(Open(picture), format)
Description
Creates a display box that contains a graphics picture object.
Returns
A reference to the display box.
Argument
Open Opens the directory that contains the picture.
picture The pathname for the picture to include.
format The graphic file format.
Example
Picture Box( Open( &quot;c:\MyPictures\logo.gif&quot;, gif ) )
Plot Col Box(&quot;title&quot;, numbers)
Description
Returns a display box labeled with the quoted string title to graph the numbers. The
numbers can be either a list or a matrix.
Popup Box({&quot;command1&quot;, script1, &quot;command2&quot;, script2, ...})
Description
Creates a red triangle menu. The single argument is an expression yielding a list of an even
number of items alternating between the command string and the expression that you want
evaluated when the command is selected. If the command is an empty string, a separator
92
JSL Functions
Display
Chapter 2
JSL Syntax Reference
line is inserted. Note: Pressing ALT and right‐clicking the red triangle menu opens a
window with check boxes for the commands. See the Using JMP book for details.
Radio Box({&quot;item&quot;, ...}, &lt;script&gt;)
Description
Constructs a display box to show a set of radio buttons. The optional script is run every
time a radio button is selected.
Range Slider Box(minValue, maxValue, lowVariable, highVariable, script)
Description
Range Slider Box() 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.
Returns
The display box (RangeSliderBox).
Arguments
min, max Numbers that set the minimum and maximum value the slider represents.
lowVar The variable whose value is set and changed by the lower slider.
highVar The variable whose value is set and changed by the upper slider.
script Any valid JSL commands that are run as the slider is moved.
Report(obj)
Description
Returns the display tree of a platform obj. This can also be sent as a message to a platform:
obj&lt;&lt;Report
Scene Box(x size, y size)
Description
Creates an x by y‐sized scene box for 3‐D graphics.
Script Box(&lt;&quot;script&quot;&gt;, &lt;width&gt;, &lt;height&gt;)
Description
Constructs an editable box that contains the quoted string script. The editable box is a
script window and can both be edited and run as JSL.
Arguments
script An optional quoted string that appears in the script box.
Chapter 2
JSL Syntax Reference
JSL Functions
Display
93
width An optional integer that sets the width of the script box.
height An optional integer that sets the height of the script box.
Scroll Box(&lt;size(h,v)&gt;, &lt;flexible(Boolean)&gt;, display box, ...)
Description
Creates a display box that positions a larger child box using scroll bars.
Returns
A reference to the scroll box object.
Arguments
size(h,v) Optional. The h and v arguments specify the size of the box in pixels.
flexible(Boolean) Optional. True (1) sets the box to be resizable with the window. False
(0) sets the box to remain the same size when the window is resized.
display box Any number of display box arguments can be contained in the scroll box.
Note
You can send a scroll box object a message to set the background color:
&lt;&lt;Set Background Color( {R, G, B} | &lt;color&gt; )
You can set the Boolean flags for horizontal (h) and vertical (v) scrolling to enable (1) or
disable (0) the scroll bars. If scrolling is disabled in a given direction, the Scroll Box will
behave as a regular container in that direction.
&lt;&lt;Set Scrollers (h, v)
To return the flags for scrolling, use the following message:
&lt;&lt;Get Scrollers
To set the horizontal (h) and vertical (v) positions (in pixels) for the scrollers on the scroll
bar:
&lt;&lt;Set Scroll Position (h,v)
To return the flags for scroll position, use the following message:
&lt;&lt;Get Scroll Position
To return the maximum positions for horizontal and vertical scrolling, use the following
message:
&lt;&lt;Get Scroll Extents
Example
The following example shows a window containing a scroll box with the specified settings.
win = New Window( &quot;Example&quot;,
sb = Scroll Box(
Size( 150, 75 ),
List Box(
{&quot;First Item&quot;, &quot;Second Item&quot;,
&quot;Third Item&quot;, &quot;Fourth Item&quot;,
94
JSL Functions
Display
Chapter 2
JSL Syntax Reference
&quot;Fifth Item&quot;},
width( 200 ),
max selected( 2 ),
nlines( 6 )
)
)
);
win &lt;&lt; Set Window Size( 300, 200 );
sb &lt;&lt; Set Scrollers( 1, 1 ); // enables both scroll bars
sb &lt;&lt; Set Scroll Position( 0, 20 ); //positions the scrollers on the scroll
bar
Sheet Part(&quot;title&quot;, display box)
Description
Returns a display box containing the display box argument with the quoted string title
as its title.
Slider Box(min, max, global, script, &lt;set width(n)&gt;, &lt;rescale slider(min,
max)&gt;)
Description
Creates an interactive slider control.
Returns
The display box (SliderBox).
Arguments
min, max Numbers that set the minimum and maximum value the slider represents.
global the global variable whose value is set and changed by the slider box.
script Any valid JSL commands that is run as the slider box is moved.
set width(n) specify the width of the slider box in pixels.
rescale slider(l, u) resets the max and min values for the slider box.
Notes
You can send Set Width and Rescale Slider as commands to a slider object. For example:
ex = .6;
New Window(&quot;Example&quot;, mybox=Slider Box(0, 1, ex, Show(ex)));
mybox&lt;&lt;Set Width(200)&lt;&lt;Rescale Slider(0, 5);
Chapter 2
JSL Syntax Reference
JSL Functions
Display
95
Spacer Box(&lt;size(h,v)&gt;, &lt;color(color)&gt;)
Description
Creates a display box that can be used to maintain space between other display boxes, or to
fill a cell in a LineUp Box.
Returns
A reference to the display box.
Arguments
size(h,v) Optional. The h and v arguments specify the size of the box in pixels.
color(color) Optional. Sets the color of the box to the JSL color argument.
String Col Box(&quot;title&quot;, {&quot;string&quot;, ...})
Description
Creates column in the table containing the string items listed.
String Col Edit Box(&quot;title&quot;, {&quot;string&quot;, ...})
Description
Creates column in the table containing the string items listed. The string boxes are
editable.
Note
To retrieve the data, use this message:
data = obj &lt;&lt; Get;
Tab Box(&quot;page title1&quot;, contents of page 1, &quot;page title 2&quot;, contents of page
2, ...)
Description
Creates a tabbed window pane. The arguments are an even number of items alternating
between the name of a tab page and the contents of the tab page.
Table Box(display box, ...)
Description
Creates a report table with the display boxes listed as columns.
Text Box(&quot;text&quot;, &lt;arguments&gt;)
Description
Constructs a box that contains the quoted string text.
96
JSL Functions
Display
Chapter 2
JSL Syntax Reference
Arguments
&lt;&lt;Justify Text(&quot;position&quot;) Justifies the text left, center, or right as specified in quotes.
&lt;&lt;Set Wrap(pixels) Sets the point at which text wraps.
Text Edit Box(&quot;text&quot;, &lt;arguments&gt;)
Description
Constructs an editable box that contains the quoted string text.
Arguments
&lt;&lt;Password Style(boolean) Displays asterisks in the box rather than the password.
&lt;&lt;Set Script Runs the specified script after the text is edited.
&lt;&lt;Set Width(pixesl) Sets the point at which text wraps.
Tree Box(&lt;{rootnodes}&gt;, &lt;size(width, height)&gt;, &lt;MultiSelect&gt;)
Description
Constructs a box to show a hierarchical tree composed of Tree Nodes.
Arguments
{rootnodes} Specifies the names for the root nodes created by Tree Node() which the box
contains.
size(width, height) Specifies the width and height (in pixels) of the box.
MultiSelect Indicates that more than one item in the tree can be selected.
Tree Node(&lt;data&gt;)
Description
Creates a node for display in a Tree Box display. Tree Node is used for both parent and
child nodes.
Triangulation(&lt;dt&gt;, X(col1, col1), &lt;Y(Col)&gt;)
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.
Examples
tri = Triangulation(
X( [0 0 1 1], [0 1 0 1] ),
Y( [0 1 2 3] )
);
dt = Open( &quot;$SAMPLE_DATA/Cities.jmp&quot; );
Chapter 2
JSL Syntax Reference
JSL Functions
Display
97
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
V Center Box(display box)
Description
Returns a display box with the display box argument centered vertically with respect to all
other sibling display boxes.
V List Box(display box, ...)
Description
Creates a display box that contains other display boxes and displays them vertically.
V Sheet Box(&lt;&lt;Hold(report), display boxes)
Description
Returns a display box that arranges the display boxes provided by the arguments in a
vertical layout. The &lt;&lt;Hold() message tells the sheet to own the report(s) that is excerpted.
V Splitter Box(&lt;size(h,v)&gt;, display box, &lt;arguments&gt;)
Description
Returns a display box that arranges the display boxes provided by the arguments in a
vertical layout (or panel). The splitter enables the user to interactively resize the panel.
Arguments
display box Any number of display box arguments can be contained in the splitter box.
Notes
For details about the optional arguments, see “H Splitter Box(&lt;size(h,v)&gt;, display box,
&lt;arguments&gt;)” on page 86.
Web Browser Box(&quot;url&quot;)
Description
Creates a display box that contains a web page. Available only on Windows.
Returns
A reference to the web browser box object.
Argument
url A quoted string containing the URL to the web page to display.
98
JSL Functions
Expression Functions
Chapter 2
JSL Syntax Reference
Window(&lt;string|int&gt;)
Returns
Either a list of references to all open windows, or a reference to an explicitly named
window.
Arguments
string A quoted string containing the name of a specific open window.
int the number of a specific open window.
Notes
If no argument is provided, a list of all open windows is returned.
If the argument (either a window name or number) does not exist, an empty list is returned.
Expression Functions
Arg(expr, i)
Arg Expr(expr, i)
Description
Finds the argument numbered by i within the given expression.
Returns
The ith argument within the expression expr.
Empty() if that argument does not exist or is not specified.
Arguments
expr an expression defined previously in the JSL script.
i an integer denoting which argument to return.
Notes
Arg Expr() was deprecated in a previous release of JMP. Use Arg() instead.
Eval Expr(expr)
Description
Evaluates any expressions within expr, but leaves the outer expression unevaluated.
Returns
An expression with all the expressions inside expr evaluated.
Argument
expr Any JSL expression.
Chapter 2
JSL Syntax Reference
JSL Functions
Expression Functions
Expr(x)
Description
Returns the argument unevaluated (expression‐quoting).
Returns
The argument, unevaluated.
Argument
x Any valid JSL expression.
Extract Expr(expr, pattern)
Description
Find expr matching pattern.
Returns
A pattern that matches the specified pattern.
Arguments
expr Any expression.
pattern Any pattern.
Head(exprArg)
Head Expr(exprArg)
Description
Returns the head of the evaluated expression, without its arguments.
Note
Head Expr() is deprecated. Use Head() instead.
Head Name(expr)
Head Name Expr(expr)
Description
Returns the head of the evaluated expression as a string.
Note
Head Name Expr() is deprecated. Use Head Name() instead.
N Arg(exprArg)
Description
Returns the number of arguments of the evaluated expression head.
99
100
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
N Arg Expr(exprArg)
Description
Returns the number of arguments of the expression head.
Name Expr(x)
Description
Returns the unevaluated expression of x rather than the evaluation of x.
File Functions
Close(&lt;dt&gt;, &lt;nosave|save(&quot;path&quot;)&gt;)
Description
Closes a data table. If no arguments are specified, the current data table is closed. If the data
table has been changed, it is automatically saved. All dependent windows are also closed
(for example, report windows that are based on the data table).
Returns
Void.
Arguments
dt an optional reference to a data table.
nosave|save(&quot;path&quot;) An optional switch to either save the data table to the specified
path before closing or to close the data table without saving it.
Close All(type, &lt;NoSave|Save&gt;)
Description
Closes all open resources of type.
Argument
type A named argument that defines the type of resources that you want to close. The
allowable types are: Data Tables, Reports, and Journals.
NoSave or Save An optional argument that specifies whether to save the specified types
of windows before closing or to close without saving.
Close Log(Boolean)
Description
Closes the log window.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
101
Convert File Path(path, &lt;&quot;absolute&quot;|&quot;relative&quot;&gt;, &lt;&quot;posix&quot;|&quot;windows&quot;&gt;,
&lt;base(path)&gt;)
Description
Converts a file path according to the arguments.
Returns
The converted path.
Arguments
path A pathname that can be either Windows or POSIX.
absolute|relative Optional quoted string, specifies whether the returned pathname is
in absolute or relative terms. The default value is absolute.
posix|windows Optional quoted string, specifies whether the returned pathname is in
Windows or POSIX style. The default is POSIX.
base(path) Optional, specifies the base pathname, useful if relative is specified. The
default is the default directory.
Copy Directory(&quot;from path&quot;, &quot;to path&quot;, &lt;recursive=Boolean&gt;)
Description
Copies files from one directory to another, optionally copying subdirectories. The directory
name is created in the to path and should not be part of the to path argument.
Returns
Returns 1 if the directory is copied; otherwise, returns 0.
Arguments
from path Specifies the directory containing the files to copy to the new directory.
to path Specifies the path where the new directory should be created and to which the
files are copied.
&lt;recursive(Boolean)&gt; Indicates whether to copy the from path subdirectory structure
to the to path.
Copy File(&quot;from path&quot;, &quot;to path&quot;)
Description
Copies one file to a new file using the same or a different name.
Returns
Returns 1 if the file is copied; otherwise, returns 0.
Arguments
from path Specifies the path and file name to copy to the new file.
to path Specifies the path and file name for the new file.
102
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
Create Database Connection( (string, &lt;DriverPrompt(1)&gt;) | &quot;Connect
Dialog&quot;);
Description
Creates a connection to the specified database or prompts the user to provide database log
in information.
Returns
A handle to the database connection.
Arguments
string The server connection string that contains information such as the data source
name and user name.
Driver Prompt An optional Boolean argument that enables the ODBC driver to prompt
for the connection information if necessary.
&quot;Connect Dialog&quot; A string that opens the Select Data Source window, from which the
user selects the database.
Examples
Specify the data source name, user name, and password:
Create Database Connection( &quot;dsn=Books;UID=johnsmith;password=Christmas&quot; );
Request that the ODBC driver prompt the user to enter connection information, because the
connection string does not specify the password:
Create Database Connection( &quot;dsn=Books;UID=johnsmith&quot;, Driver Prompt( 1 ) );
Enable the user to select the data source, specify &quot;Connect Dialog&quot;:
Create Database Connection( &quot;Connect Dialog&quot; );
Create Directory(&quot;path&quot;)
Description
Creates a new directory at the specified path location.
Returns
Returns 1 if the directory is created; otherwise, returns 0.
Arguments
path Specifies the path where the new directory should be located.
Creation Date(&quot;path&quot;)
Description
Returns the creation date for the specified file or directory.
Returns
Creation date.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
Arguments
path Specifies the directory or path and file name for the query.
Delete Directory(&quot;path&quot;)
Description
Deletes the specified directory and its contents and any subdirectories.
Returns
Returns 1 if the directory is deleted; otherwise, returns 0.
Arguments
path Specifies the path and directory for deletion.
Delete File(&quot;path&quot;)
Description
Deletes the specified file.
Returns
Returns 1 if the file is deleted; otherwise, returns 0.
Arguments
path Specifies the path and file name for deletion.
Directory Exists(&quot;path&quot;)
Description
Verifies the specified directory exists.
Returns
Returns 1 if the directory exists; otherwise returns 0.
Arguments
path Specifies the path and directory for verification.
File Exists(&quot;path&quot;)
Description
Verifies the specified file name exists at the specified path.
Returns
Returns 1 if the file exists; otherwise returns 0.
Arguments
path Specifies the path and file name for verification.
103
104
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
Files In Directory(path, &lt;&quot;recursive&quot;&gt;)
Description
Returns a list of filenames in the path given.
Returns
List of filenames. If &quot;recursive&quot; is not specified, directory names are included in the list.
Arguments
path A valid pathname.
recursive An optional quoted keyword that causes all folders in the path (and all folders
that they contain, and so on) to be searched for files.
Get Current Directory()
Description
Retrieves the current directory, which is used in the Open File window. Note: The operating
system can change the current directory outside of JMP.
‒ If JMP was opened using the JMP shortcut, the function returns the JMP Installation
directory. For example, on Windows, the current directory is ʺ/C:/Program Files/SAS/
JMPPRO/&lt;version&gt;/ʺ or ʺ/C:/Program Files/SAS/JMP/&lt;version&gt;/ʺ.
‒ If JMP was opened by double‐clicking a JMP file (.jmp, .jsl, .jrn, and so on), the
command returns the path of the opened file.
‒ If the current directory was configured using the Set Current Directory() function,
JMP returns the specified path.
See “Set Current Directory(ʺpathʺ)” on page 113.
Returns
The absolute pathname as a string.
Arguments
none
Get Default Directory()
Description
Retrieves the user’s default directory. This path is used for subsequent relative paths.
If the default directory was set using Set Default Directory(), JMP returns the specified
path as long as Get Default Directory() and Set Default Directory() are in the same
script.
See “Set Default Directory(ʺpathʺ)” on page 113.
Returns
The absolute pathname as a string.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
Arguments
none
Get File Search Path()
Description
Retrieves the current list of directories to search for opening files.
This list is configured using the Set File Search Path() function. See “Set File Search
Path({path or list of paths})” on page 113.
Returns
A list of pathnames as strings.
Get Path Variable(&quot;name&quot;)
Description
Retrieves the value of name, a path variable.
Returns
The absolute pathname as a string.
Argument
name A quoted string that contains a path variable. (Examples: SAMPLE_DATA,
SAMPLE_SCRIPTS)
Is Directory(path)
Description
Returns 1 if the path argument is a directory and 0 otherwise.
Is Directory Writable(path)
Description
Returns 1 if the directory specified in the path argument is writable and 0 otherwise.
Is File(path)
Description
Returns 1 if the path argument is a file and 0 otherwise.
Is File Writable(path)
Description
Returns 1 if the file specified in the path argument is writable and 0 otherwise.
105
106
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
Is Log Open()
Description
Returns a Boolean value that indicates whether the log window is open.
Last Modification Date(&quot;path&quot;)
Description
Returns the last modification date of the specified file or directory.
Returns
Last modification date.
Arguments
path Specifies the directory or file name.
Load Text File(path, &lt;XMLParse|SASODSXML&gt;)
Description
Opens the text file stored at path.
Returns
The text contained in the file.
Arguments
path A pathname that points to a text file. This can be a URL.
XMLParse Optional argument that causes an XML text file to be converted into JSL.
SASODSXML Optional argument that causes the text file to be parsed as SAS ODS default
XML.
Move Directory(&quot;from path&quot;, &quot;to path&quot;)
Description
Moves a directory and its contents (including subdirectories) from the specified path to
another specified path.
Returns
Returns 1 if the directory is moved; otherwise returns 0.
Arguments
from path Specifies the path and directory for relocation.
to path Specifies the destination path and directory.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
107
Move File(&quot;from path&quot;, &quot;to path&quot;)
Description
Moves a file from the specified path to another specified path with the same or different file
name.
Returns
Returns 1 if the file is moved; otherwise returns 0.
Arguments
from path Specifies the path and file name for relocation.
to path Specifies the destination path and file name.
Notes
On Windows, when you move a file to a folder that does not exist, Windows creates the
folder and returns 1. On Macintosh, the folder is not created, and an error is returned.
Open(&quot;path&quot;, &lt;arguments&gt;)
Description
Opens the data table or other JMP file or object created from a file named by the path. If no
path is specified, the Open window appears. Refer to the examples in the JMP Scripting
Index for details on which arguments apply to specific file types.
Arguments
Charset(&quot;option&quot;) The available character set options for importing text files are &quot;Best
Guess&quot;, &quot;utf-8&quot;, &quot;utf-16&quot;, &quot;us-ascii&quot;, &quot;windows-1252&quot;, &quot;x-max-roman&quot;,
&quot;x-mac-japanese&quot;, &quot;shift-jis&quot;, &quot;euc-jp&quot;, &quot;utf-16be&quot;, and &quot;gb2312&quot;.
Column Names Start(n) | Column Names are on line(n) Specifies the line number
that column names start in the imported text file. If the text file uses returns between
cells, column names could be on multiple lines.
Columns(colName = colType(colWidth),...) Specifies the columns by name in the
text file to import into a data table where:
‒ colName: Specifies the column name used in the imported text file.
‒ colType(Character | Numeric): Indicates whether the specified column contains
character or numeric data.
‒ colWidth(n): indicates the integer width of the specified column.
Columns(&lt;arguments&gt;) For ESRI shapefiles (.shp), this argument and its settings indicate
the following:
‒ Shape=numeric(n): Indicates the column number in the imported ESRI shapefile that
contains the shape number.
‒ Part=numeric(n): Indicates the column number in the imported ESRI shapefile that
contains the part number.
108
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
‒ X=numeric(n): Indicates the column number in the imported ESRI shapefile that
contains the decimal degree for the longitude (range of &plusmn;180&deg;).
‒ Y=numeric(n): Indicates the column number in the imported ESRI shapefile that
contains the decimal degree for the latitude (range of &plusmn;90&deg;).
Compress Allow List Check(Boolean) Indicates that JMP can compress data table
created from the imported text file.
Compress Character Columns(Boolean) Indicates that JMP should compress data table
columns that contain character data from the imported text file.
Compress Numeric Columns(Boolean) Indicates that JMP should compress data table
columns that contain numeric data from the imported text file.
Concatenate Worksheets(Boolean) Indicates that JMP should combine the imported
Excel worksheets into one data table.
Create Concatenation Column(Boolean) Indicates that JMP should combine columns
from an imported Excel file into one column.
Data Starts(n) | Data Starts on Line(n) Specifies the line number where data
starts in the imported text file.
Debug JSL(Boolean) Opens the specified JSL script in the Debugger instead of opening it.
End Of Field(Tab|Space|Comma|Semicolon|Other|None) Specifies the character used
to delimit the end of a field in the imported text file. To specify multiple characters,
separate each character designation by a comma. If you use “Other”, designate the
delimiter with EOF Other() argument.
End Of Line(CRLF|CR|LF|Semicolon|Other) Specifies the character used to delimit the
end of a line in the imported text file. To specify multiple characters, separate each
character designation by a comma. If you use “Other”, designate the delimiter with EOL
Other() argument.
EOF Other(&quot;char&quot;) If the imported text file uses an end of field character other than the
one specified by End of Field, this argument specifies the character used.
EOL Other(&quot;char&quot;) If the imported text file uses an end of line character other than the
one specified by End of Line, this argument specifies the character used.
File Type An optional string that specifies the type of file that you are opening (for
example, xls, bmp, jpg, or gif ). If you do not specify this string, the file opens in the
default program for the file type.
Note: The path argument should be used for a zip archive. The extension (.zip) is not
required. See “Zip Archives” on page 371 in the “JSL Messages” chapter for the messages
that you can send to a zip archive. The basic functionality is to get a list of files in the zip
archive, to read a file in the zip archive into either a string or a blob, and to write files into
the zip archive. Note that reading a zip archive temporarily puts the contents into
memory. Reading very large zip archives can cause errors.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
109
Force Refresh Closes the specified JMP (.jrn, .jsl, .jrp, or .jmpappsource) file without
saving and tries to reopen the file from disk. This argument deletes any changes made
since the last time the file was opened.
HTML Table(n) To import a table from an HTML web page, use the URL as the filepath.
This optional argument specifies which table number, n, on the web page to open. If you
omit the value, only the first table on the page is imported.
Tip: If the table you are importing contains images, they are first imported as text. To load
the images in your JMP data table, run the automatically generated table script named
Load Pictures. A new expression column containing the images is created.
Ignore Columns( &quot;col&quot;, ... ) Indicates the column names in the JMP data table or
other JMP file that should not be included in the data table.
Invisible Opens the file as invisible. This quoted keyword applies to the files: data table,
JMP file, external, text, Excel, SAS, ESRI shapefile, or HTML. The data table appears only
in the JMP Home Window and the Window menu.
Labels(Boolean) Indicates the imported text file contains labels or column headers as the
first line in the file. The default value is True.
Lines to Read(n) Specifies the number of lines in the text file to import. JMP starts
counting lines after column names are read.
Number of Columns(n) Specifies the number of columns contained in the imported text
file.
Run JSL(Boolean) Runs the specified JSL file instead of opening it. Include a Boolean
argument or an expression that contains a Boolean value. If the script begins with //!,
which automatically runs the script, include the Boolean value (0) to open the script
instead.
Password( &quot;password&quot; ) Specifies the password for a password‐protected Microsoft
Excel .xls or SAS files to avoid entering it manually. The password is not encrypted.
(Password‐protected Microsoft Excel .xlsx files cannot be imported.)
Private Opens the table as invisible and without showing it in the JMP Home Window or
Window menu. For example, you might create a private data table to hold temporary
data that the user does not need to see. This quoted keyword applies to the following
files: data table, JMP file, external, text, Excel, SAS, ESRI shapefile, or HTML.
Scan Whole File(Boolean) Specifies how long JMP scans the text file to determine data
types for the columns. This is a Boolean value. The default value is true; the entire file is
scanned until the data type is determined. To import large files, consider setting the
value to false, which scans the file for five seconds.
Select Columns( &quot;col&quot;, ... ) Indicates the column names in the JMP data table or
other JMP file that should be included in the data table.
110
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
Strip Quotes | Strip Enclosing Quotes (Boolean) If the fields in the text file are
quoted, setting this to True removes the quotes, and setting it to False does not remove
the quotes. The default value is True.
Table Contains Column Headers (Boolean) Indicates the imported text file contains
labels or column headers as the first line in the file. The default value is True.
Treat Empty Columns as Numeric(Boolean) Indicates that JMP should import text file
columns of missing data as numeric rather than character. Possible missing value
indicators are a period, a Unicode dot, NaN, or a blank string. The default value is
False.
Use Apostrophe as Quotation Mark(Boolean) Declares apostrophes as quotation
marks in importing text files. This option is not recommended unless your data comes
from a nonstandard source that places apostrophes around data fields rather than
quotation marks. The default value is False.
Use Labels for Var Names(Boolean) For SAS data sets, this option specifies to use SAS
labels as JMP columns names. The default value is False.
Use for all sheets(Boolean) Indicates that JMP should use the Worksheets settings
for all worksheets in the Excel file to be opened as a data table.
Worksheet Options(Boolean, &lt;options&gt;) Specifies options for importing an Excel file
into a JMP data sheet. Available options are:
‒ Has Column Headers(Boolean) ‐ Indicates the Excel file has column headers in the first
row.
‒ Number of Rows in Headers(n) ‐ Specifies the number of rows in the Excel file used as
column headers.
‒ Headers Start on Row(n) ‐ Specifies the row number in the Excel file where the
column headers begin. Default is row 1.
‒ Data Starts on Row(n) ‐ Specifies the row number in the Excel file where the data
begins.
‒ Data Starts on Column(n) ‐ Specifies the column number in the Excel file where the
data begins.
‒ Data Ends on Row(n) ‐ Specifies the row number in the Excel file where data ends.
‒ Data Ends on Column(n) ‐ Specifies the column number in the Excel file where the
data ends.
‒ Replicated Spanned Rows(Boolean) ‐ Indicates the Excel file contains spanned
columns that should be imported into JMP as spanned columns.
‒ Suppress Hidden Rows(Boolean) ‐ Indicates that JMP should not import rows hidden
in the Excel file.
‒ Suppress Hidden Columns(Boolean) ‐ Indicates that JMP should not import columns
hidden in the Excel file.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
111
‒ Treat as Hierarchy(Boolean) ‐ Indicates that JMP should treat multiple column
headers (merged cells) as hierarchies when importing an Excel file. If True, the Excel
file opens with the merged columns stacked (Tables &gt; Stacked).
Worksheets (&quot;sheet name&quot;|{&quot;sheet name&quot;, &quot;sheet name&quot;,...}|”n”) Opens the
specified Excel file worksheet by name, all worksheets in a list of names, or the indexed
number of the worksheet. If the worksheets are not specified, all worksheets in the
spreadsheet open as separate data tables.
Year Rule | Two digit year rule
(&quot;1900-1999&quot;|&quot;1910-2009&quot;|&quot;1920-2019&quot;|&quot;1930-2029&quot;|&quot;1940-2039&quot;|
&quot;1950-2049&quot;|&quot;1960-2059&quot;|&quot;1970-2069&quot;|&quot;1980-2079&quot;|&quot;1990-2089&quot;|&quot;2000-2099&quot;)
Indicates the year format used in the imported text file. For example, if the earliest date is
1979, use “1970‐2069”.
Open Database(&quot;connectInfo&quot; &quot;sqlStatement&quot;, &quot;outputTableName&quot;)
Description
Opens the database indicated by connectInfo with the sqlStatement, returning a data
table named outputTableName.
Pick Directory(&lt;&quot;prompt string&quot;&gt;)
Description
Prompts the user for a directory, returning the directory path as a string.
Returns
The path for the directory that the user selects.
Arguments
prompt An optional quoted string. If provided, that string appears at the top of the Browse
window on Windows.
Pick File(&lt;&quot;prompt&quot;&gt;, &lt;&quot;initial directory&quot;&gt;, &lt;{filter list}&gt;, &lt;first
filter&gt;, &lt;save flag&gt;, &lt;&quot;default file&quot;&gt;), &lt;multiple&gt;
Description
Prompts the user to select one or more files in the Open window.
Returns
The path of the file that the user selects.
Arguments
prompt An optional quoted string. If provided, that string appears at the top of the Open
window.
112
JSL Functions
File Functions
Chapter 2
JSL Syntax Reference
initial directory An optional quoted string that is a valid filepath to a folder. If
provided, it specifies where the Open window begins. If not provided, or if it’s an empty
string, the JMP Default Directory is used.
filter list An optional list of quoted strings that define the filetypes to show in the
Open window. See the following example for syntax.
first filter An optional integer that specifies which of the filters in the filter list to use
initially. If you use an integer that is too large or small for the list (for example, 4 for a list
of 3), the first filter in the list is used.
save flag An optional Boolean that specifies whether the Open window or Save window
is used. 0 lets the user select a file to open in JMP. 1 lets the user save a new, empty file of
the selected type in the selected folder. The default value is 0.
default file The name of the file that appears in the window by default.
multiple An optional argument that lets the user select multiple files if the save flag is 0.
Notes
Although all arguments are optional, they are also positional. For example, you cannot
specify a filter list without also specifying the caption and the initial directory.
The buffer size in the computer’s physical memory affects the number of files the user can
open.
Example
The following script assigns Select JMP File as the window title; shows the Documents
directory; shows JMP Files and All Files in the File name list and selects JMP Files; displays
the Open window; and shows the file name Earthquakes.jmp.
Pick File(&quot;Select JMP File&quot;, &quot;$DOCUMENTS&quot;, {&quot;JMP Files|jmp;jsl;jrn&quot;, &quot;All
Files|*&quot;}, 1, 0, &quot;Earthquakes.jmp&quot;)
Rename Directory(&quot;old path name&quot;, &quot;new directory name&quot;)
Description
Renames a directory without moving or copying it.
Returns
Returns 1 if the directory is renamed; otherwise, returns 0.
Arguments
old path name Specifies the path and old directory name.
new name Specifies the new directory name.
Notes
When you specify the new directory name, include only the directory name, not the
entire path.
Chapter 2
JSL Syntax Reference
JSL Functions
File Functions
113
Rename File(&quot;old path name&quot;, &quot;new name&quot;)
Description
Renames a file without moving or copying it.
Returns
Returns 1 if the file is renamed; otherwise, returns 0.
Arguments
old path name Specifies the path and old file name.
new name Specifies the new file name.
Notes
When you specify the new name, include only the file name, not the entire path.
Save Text File(path, text)
Description
Saves the JSL variable text into the file specified by path.
Set Current Directory(&quot;path&quot;)
Description
Sets the current directory for Open File operations. Note: The operating system can change
the current directory outside of JMP.
To avoid having to set the current directory for each file operation, define a filepath string
and concatenate it with the filename. See the Path Variables section in the Scripting Guide for
details.
See “Get Current Directory()” on page 104.
Set Default Directory(&quot;path&quot;)
Description
Sets the default directory, which is used for resolving relative paths.
See “Get Default Directory()” on page 104.
Set File Search Path({path or list of paths})
Description
Sets the current list of directories to search for opening files. Using {ʺ.ʺ} as the path
configures JMP to use the current directory.
See “Get File Search Path()” on page 105.
114
JSL Functions
Financial Functions
Chapter 2
JSL Syntax Reference
Example
Set File Search Path( {&quot;C:\JMP\12\source&quot;, &quot;C:\Program
Files\SAS\JMPPRO\12\Samples&quot;} );
Set Path Variable(&quot;name&quot;)
Description
Sets the path stored in the variable.
Financial Functions
Double Declining Balance(cost, salvage, life, period, &lt;factor&gt;)
Description
Returns the depreciation of an asset for a specified period of time. The function uses the
double‐declining balance method or some other depreciation factor.
Arguments
cost The initial cost.
salvage The value at the end of the depreciation.
life The number of periods in the depreciation cycle.
period The length of the period, in the same units as life.
factor An optional number that is the rate at which the balance declines. The default
value is 2.
Note
This function is equivalent to the Excel function DDB.
Future Value(rate, nper, pmt, &lt;pv&gt;, &lt;type&gt;)
Description
Returns the future value of an investment that is based on periodic, constant payments and
a constant interest rate.
Arguments
rate The interest rate.
nper The number of periods.
pmt The constant payment.
pv An optional number that is the present value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Chapter 2
JSL Syntax Reference
JSL Functions
Financial Functions
115
Note
This function is equivalent to the Excel function FV.
Interest Payment(rate, per, nper, pv, &lt;fv&gt;, &lt;type&gt;)
Description
Returns the interest payment for a given period for an investment that is based on periodic,
constant payments and a constant interest rate.
Arguments
rate The interest rate.
per The period for which you want the interest.
nper The total number of periods.
pv The present value.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Note
This function is equivalent to the Excel function IPMT.
Interest Rate(nper, pmt, pv, &lt;fv&gt;, &lt;type&gt;, &lt;guess&gt;)
Description
Returns the interest rate per period of an annuity.
Arguments
nper The total number of periods.
pmt The constant payment.
pv The present value.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
guess An optional number that is what you think the rate will be. The default value is 0.1
(10%).
Note
This function is equivalent to the Excel function RATE.
116
JSL Functions
Financial Functions
Chapter 2
JSL Syntax Reference
Internal Rate of Return(values, &lt;guess&gt;)
Internal Rate of Return(guess, value1, value2, ...)
Description
Returns the internal rate of return for a series of cash flows in the values argument.
Arguments
values A one‐dimensional matrix of values. If the second form of the function is used, list
each value separately.
guess The number that you think is near the result. The default value is 0.1 (10%).
Note
This function is equivalent to the Excel function IRR.
Modified Internal Rate of Return(values, finance rate, reinvest rate)
Modified Internal Rate of Return(finance rate, reinvest rate, value1,
value2, ...)
Description
Returns the modified internal rate of return for a series of periodic cash flows. The cost of
investment and the interest received on reinvested cash is included.
Arguments
values A one‐dimensional matrix of values. If the second form of the function is used, list
each value separately.
finance rate The interest rate that you pay on the money in the cash flows.
reinvest rate The interest rate that you receive on the cash flows when you reinvest
them.
Note
This function is equivalent to the Excel function MIRR.
Net Present Value(rate, values)
Net Present Value(rate, value1, value2, ...)
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).
Arguments
rate The discount rate.
values A one‐dimensional matrix of values. If the second form of the function is used, list
each value separately.
Chapter 2
JSL Syntax Reference
JSL Functions
Financial Functions
117
Note
This function is equivalent to the Excel function NPV.
Number of Periods(rate, pmt, pv, &lt;fv&gt;, &lt;rate&gt;)
Description
Returns the number of periods for an investment that is based on periodic, constant
payments and a constant interest rate.
Arguments
rate The interest rate.
pmt The constant payment.
pv The present value.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Note
This function is equivalent to the Excel function NPER.
Payment(rate, nper, pv, &lt;fv&gt;, &lt;type&gt;)
Description
Returns the payment for a loan that is based on constant payments and a constant interest
rate.
Arguments
rate The interest rate.
nper The total number of periods.
pv The present value.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Note
This function is equivalent to the Excel function PMT.
Present Value(rate, nper, pmt, &lt;fv&gt;, &lt;type&gt;)
Description
Returns the present value of an investment.
Arguments
rate The interest rate per period.
118
JSL Functions
Financial Functions
Chapter 2
JSL Syntax Reference
nper The total number of periods.
pmt The constant payment.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Note
This function is equivalent to the Excel function PV.
Principal Payment(rate, per, nper, pv, &lt;fv&gt;, &lt;type&gt;)
Description
Returns the payment on the principal for a given period for an investment that is based on
periodic, constant payments and a constant interest rate.
Arguments
rate The interest rate per period.
per The period for which you want the interest.
nper The total number of periods.
pv The present value.
fv An optional number that is the future value. The default value is 0.
type An optional switch. 0 specifies end‐of‐period payments, and 1 specifies
beginning‐of‐period payments. The default value is 0.
Note
This function is equivalent to the Excel function PPMT.
Straight Line Depreciation(cost, salvage, life)
Description
Returns the straight‐line depreciation of an asset for one period.
Arguments
cost The initial cost of the asset.
salvage The value at the end of the depreciation.
life The number of periods in the depreciation cycle.
Note
This function is equivalent to the Excel function SLN.
Sum Of Years Digits Depreciation(cost, salvage, life, per)
Description
Returns the sum‐of‐years’ digits depreciation of an asset for a specified period.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
119
Arguments
cost The initial cost of the asset.
salvage The value at the end of the depreciation.
life The number of periods in the depreciation cycle.
per The length of the period, in the same units as life.
Note
This function is equivalent to the Excel function SYD.
Graphic Functions
Add Color Theme({&quot;name&quot;, &lt;flags&gt;, {color}, &lt;{position}&gt;)
Description
Creates a custom color theme that you can apply to components such as markers, data table
rows, and treemaps. Add the color theme to the JMP Preferences by including Add Color
Theme(...) inside Preferences().
Returns
Null.
Arguments
name The name of the color theme.
flags An optional flag for the Continuous or Categorical color theme list and category of
color.
Continuous, &lt;Continuous&gt;, Sequential
Continuous, &lt;Continuous&gt;, Diverging
Continuous, &lt;Continuous&gt;, Chromatic
Categorical, &lt;Continuous&gt;, Sequential
Categorical, &lt;Continuous&gt;, Diverging
Categorical, Qualitative
Categorical, &lt;Continuous&gt;, Chromatic
With the default JMP color themes, Sequential colors transition from left to right or right to
left. Diverging colors are lighter in the middle. Chromatic colors consist of blocks or
gradients of bright color. All categories except for Qualitative can be both continuous and
categorical.
If you omit the flag, the color is shown in the Continuous, Sequential and Categorical,
Sequential categories.
120
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
color Lists of RGB values. These values define the blocks in categorical color themes and
the gradients in continuous color themes. Each list of RGB values corresponds to a slider
in the preferences Color Themes window.
position An optional list of numbers between 0 and 1 with one position per color. Each
position corresponds to a slider in the preferences Color Themes window. If you omit the
position, the sliders are evenly spaced.
Examples
The following example creates a continuous color theme named Blue to Purple. The color is
in the Diverging category. RGB values are defined in the four lists.
Add Color Theme(
{&quot;Blue to Purple&quot;, {&quot;Continuous&quot;, &quot;Diverging&quot;}, {{0, 0, 255},
{57, 108, 244}, &quot;white&quot;, {128, 0, 100}}} );
Notes
Any style except for Qualitative can be Continuous and Categorical at the same time. For
example, the Cool to Warm Diverging theme is in the Continuous and Categorical theme
lists. In JMP, select Preferences &gt; Graphs to see examples.
To delete a color theme, use Remove Color Theme(&quot;name&quot;).
Arc(x1, y1, x2, y2, startangle, endangle)
Description
Inscribes an arc in the rectangle described by the arguments.
Returns
Null.
Arguments
x1, y1 The point at the top left of the rectangle
x2, y2 The point at the bottom right of the rectangle
startangle, endangle The starting and ending angle in degrees, where 0 degrees is 12
oʹclock and the arc or slice is drawn clockwise from startangle to endangle.
Arrow(&lt;pixellength&gt;, {x1, y1}, {x2, y2})
Description
Draws an arrow from the first point to the second point. The optional first argument
specifies the length of the arrow’s head lines (in pixels).
Returns
Null.
Arguments
pixellength Optional: specifies the length of the arrowhead in pixels.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
121
{x1, y1}, {x2, y2} Two lists of two numbers that each specify a point in the graph.
Notes
The two points can also be enclosed in square brackets: Arrow(&lt;pixellength&gt;, [x1, x2],
[y1, y2]).
Back Color(&quot;name&quot;)
Description
Sets the color used for filling the graph’s background.
Returns
Null.
Argument
name A quoted color name or a color index (such as ʺredʺ or ʺ3ʺ for the color red).
Char To Path(&quot;path&quot;)
Description
Converts a path specification from a string to a matrix.
Returns
A matrix.
Arguments
path A string that contains the path specification.
Circle({x, y}, radius|PixelRadius(n), &lt;...&gt;, &lt;&quot;fill&quot;&gt;)
Description
Draws a circle centered at {x, y} with the specified radius.
Returns
Null.
Arguments
{x, y} A number that describes a point in the graph
radius A number that describes the length of the circle’s radius in relation to the vertical
axis. If the vertical axis is resized, the circle is also resized.
PixelRadius(n) A number that describes the length of the circle’s radius in pixels. If the
vertical axis is resized, the circle is not resized.
&quot;fill&quot; Optional string. Indicates that all circles defined in the function are filled with the
current fill color. If &quot;fill&quot; is omitted, the circle is empty.
122
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
Note
The center point and the radius can be placed in any order. You can also add additional
center point and radius arguments and draw more than one circle in one statement. One
point and several radii results in a bull’s‐eye. Adding another point still draws all previous
circles, and then adds an additional circle with the last radius specified. This means that
this code:
graphbox(circle({20, 30}, 5, {50, 50}, 15))
results in three circles, not two. First, a circle with radius 5 is drawn at 20, 30. Second, a
circle with radius 5 is drawn at 50, 50. Third, a circle with radius 15 is drawn at 50, 50.
Color To HLS(color)
Description
Converts the color argument (including any JMP color) to a list of HLS values.
Returns
A list of the hue, lightness, and saturation components of color. The values range between
0 and 1.
Argument
color a number from the JMP color index.
Example
The output from ColorToHLS() can either be assigned to a single list variable or to a list of
three scalar variables:
hls = colortohls(8);
{h, l, s} = colortohls(8);
show(hls, h, l, s);
hls = {0.778005464480874, 0.509803921568627, 0.976};
h = 0.778005464480874;
l = 0.509803921568627;
s = 0.976;
Color To RGB(color)
Description
Converts the color argument (including any JMP color) to a list of RGB values.
Returns
A list of the red, green, and blue components of color. The values range between 0 and 1.
Argument
color a number from the JMP color index.
Example
The output from ColorToRGB() can either be assigned to a single list variable or to a list of
three scalar variables:
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
123
rgb = colortorgb(8);
{r, g, b} = colortorgb(8);
show(rgb, r, g, b);
rgb = {0.670588235294118, 0.0313725490196078, 0.988235294117647};
r = 0.670588235294118;
g = 0.0313725490196078;
b = 0.988235294117647;
Contour(xVector, yVector, zGridMatrix, zContour, &lt;zColors&gt;)
Description
Draws contours given a grid of values.
Returns
None.
Arguments
xVector The n values that describe zGridMatrix.
yVector The m values that describe zGridMatrix.
zGridMatrix An nxm matrix of values on some surface.
zContour Optional: Definition of values for the contour lines.
zColors Optional: Definition of colors to use for the contour lines.
Contour Function(expr, xName, yName, z, &lt; &lt;&lt;XGrid(min, max, incr)&gt;, &lt;
&lt;&lt;YGrid(min, max, incr)&gt;, &lt; &lt;&lt;zColor(color)&gt;, &lt; &lt;&lt;zLabeled&gt;, &lt; &lt;&lt;Filled&gt;, &lt;
&lt;&lt;FillBetween&gt;, &lt; &lt;&lt;Ternary&gt;, &lt; &lt;&lt;Transparency(alpha|vector))
Description
Draws sets of contour lines of the expression, a function of the two symbols. The z
argument can be a single value or an index or matrix of values.
Returns
None.
Arguments
expr Any expression. For example, Sine(y)+Cosine(x).
xName, yName Values to use in the expression.
z A z‐value or a matrix of z‐values.
Optional Arguments
&lt;&lt;XGrid, &lt;&lt;YGrid Defines a box, beyond which the contour lines are not drawn.
&lt;&lt;zColor Defines the color in which to draw the contour lines. The argument can be either
a scalar or a matrix, but must evaluate to numeric.
&lt;&lt;zLabeled Labels the contours.
&lt;&lt;Filled Fills the contour levels using the current fill color.
124
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
&lt;&lt;FillBetween Fills only between adjacent contours using the current fill color. For nz
contours specified, this option fills nz‐1 regions for the intervals between the nz values.
Using this option is recommended over using the &lt;&lt;Filled option.
&lt;&lt;Ternary Clips lines to be within the ternary coordinate system inside ternary plots.
&lt;&lt;Transparency sets the transparency level of the fill. A vector of numbers between 0 and
1 are sequenced through and cycled for the z contours. This option should be used only
in conjunction with the &lt;&lt;FillBetween option.
Drag Line(xMatrix, yMatrix, &lt;dragScript&gt;, &lt;mouseupScript&gt;)
Description
Draws line segments between draggable vertices at the coordinates given by the matrix
arguments.
Returns
None.
Arguments
xMatrix A matrix of x‐coordinates.
yMatrix A matrix of y‐coordinates.
dragScript Any valid JSL script; it is run at drag.
mouseupScript Any valid JSL script; it is run at mouseup.
Drag Marker(xMatrix, yMatrix, &lt;dragScript&gt;, &lt;mouseupScript&gt;)
Description
Draws draggable markers at the coordinates given by the matrix arguments.
Returns
None.
Arguments
xMatrix A matrix of x‐coordinates.
yMatrix A matrix of y‐coordinates.
dragScript Any valid JSL script; it is run at drag.
mouseupScript Any valid JSL script; it is run at mouseup.
Drag Polygon(xMatrix, yMatrix, &lt;dragScript&gt;, &lt;mouseupScript&gt;)
Description
Draws a filled polygon with draggable vertices at the coordinates given by the matrix
arguments.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
125
Returns
None.
Arguments
xMatrix A matrix of x‐coordinates.
yMatrix A matrix of y‐coordinates.
dragScript Any valid JSL script; it is run at drag.
mouseupScript Any valid JSL script; it is run at mouseup.
Drag Rect(xMatrix, yMatrix, &lt;dragScript&gt;, &lt;mouseupScript&gt;)
Description
Draws a filled rectangle with draggable vertices at the first two coordinates given by the
matrix arguments.
Returns
None.
Arguments
xMatrix A matrix of 2 x‐coordinates.
yMatrix A matrix of 2 y‐coordinates.
dragScript Any valid JSL script; it is run at drag.
mouseupScript Any valid JSL script; it is run at mouseup.
Note
xMatrix and yMatrix should each contain exactly two values. The resulting coordinate
pairs should follow the rules for drawing a rect(); the first point (given by the first value
in xMatrix and the first value in yMatrix) must describe the top, left point in the rectangle,
and the second point (given by the second value in xMatrix and the second value in
yMatrix) must describe the bottom, right point in the rectangle.
Drag Text(xMatrix, yMatrix, &quot;text&quot;, &lt;dragScript&gt;, &lt;mouseupScript&gt;)
Description
Draws the text (or all the items if a list is specified) at the coordinates given by the matrix
arguments.
Returns
None.
Arguments
xMatrix A matrix of x‐coordinates.
yMatrix A matrix of y‐coordinates.
text A quoted string to be drawn in the graph.
126
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
dragScript Any valid JSL script; it is run at drag.
mouseupScript Any valid JSL script; it is run at mouseup.
Fill Color(n)
Description
Sets the color used for filling solid areas.
Returns
None.
Argument
n Index for a color or a quoted color name.
Fill Pattern()
Description
Obsolete. Patterns have been removed. Use Transparency() instead.
Gradient Function(zexpr, xname, yname, [zlow, zhigh], zcolor([colorlow,
colorhigh]), &lt; &lt;&lt;XGrid(min, max, incr)&gt;, &lt; &lt;&lt;YGrid(min, max, incr)&gt; &lt;
&lt;&lt;Transparency(alpha|vector))
Description
Fills a set of rectangles on a grid according to a color determined by the expression value as
it crosses a range corresponding to a range of colors.
Example
Gradient Function(Log(a * a + b * b),
a, b, [2 10],
Z Color([4, 6]));
Zexpr is a function in terms of the two following variables (a and b), whose values range
from zlow to zhigh (2 to 10). Zcolor defines the two colors that are blended together (4 is
green, 6 is orange).
H Line(&lt;x1, x2&gt;, y)
Description
Draws a horizontal line at y across the graph. If you specify start and end points on the
x‐axis (x1 and x2), the line is drawn horizontally at y from x1 to x2. You can also draw
multiple lines by using a matrix of values in the y argument.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
127
H Size()
Description
Returns the horizontal size of the graphics frame in pixels.
Handle(a, b, dragScript, mouseupScript)
Description
Places draggable marker at coordinates given by a, b. The first script is executed at drag
and the second at mouseup.
Heat Color(n, &lt;&quot;color theme&quot;&gt;)
Description
Returns the JMP color that corresponds to n in the color ʺtheme&quot;.
Returns
An integer that is a JMP color.
Arguments
n A value between 0 and 1.
theme Any quoted color theme that is supported by Cell Plot. The default value is ʺBlue to
Gray to Redʺ.
HLS Color(h, l, s)
HLS Color({h, l, s})
Description
Converts hue, lightness, and saturation values into a JMP color number.
Returns
An integer that is a JMP color number.
Arguments
Hue, lightness, and saturation, or a list containing the three HLS values. All values
should be between 0 and 1.
In Path(x, y, path)
Description
Determines it the point described by x and y falls in path.
Returns
True (1) if the point (x, y) is in the given path, False(0) otherwise.
128
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
Arguments
x and y The coordinates of a point.
path Either a matrix or a string describing a path.
In Polygon(x, y, xx, yy)
In Polygon(x, y, xyPolygon)
Description
Returns 1 or 0, indicating whether the point (x, y) is inside the polygon that is defined by
the xx and yy vector arguments.
The vector arguments (xx, yy) can also be combined into a 2‐column matrix (xyPolygon),
allowing you to use three arguments instead of four. Also, x and y can be conformable
vectors, and then a vector of 0s and 1s are returned based on whether each (x, y) pair is
inside the polygon.
Level Color(i, &lt;n&gt;, &lt;&quot;Color Theme&quot;&gt;)
Description
Assigns a JMP color to categorical data in a graphic.
Returns
An integer that is a JMP color.
Arguments
i An integer that is greater than or equal to 1 and less than or equal to the number of
categories specified by n.
n The number of categories.
&quot;Color Theme&quot; A color theme from the Value Color list of the Column Properties window.
If not specified, the JMP Default color theme is applied.
Note
When the second argument is a character string and not n, then the second argument
determines the color theme.
Line({x1, y1}, {x2, y2}, ...)
Line([x1, x2, ...], [y1, y2, ...})
Description
Draws a line between points.
Arguments
Can be any number of lists of two points, separated by commas; or a matrix of x’s and a
matrix of y’s.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
129
Line Style(n)
Description
Sets the line style used to draw the graph.
Argument
n Can be either a style name or the style’s number:
‒ 0 or Solid
‒ 1 or Dotted
‒ 2 or Dashed
‒ 3 or DashDot
‒ 4 or DashDotDot
Marker(&lt;markerState&gt;, {x1, y1}, {x2, y2}, ...)
Marker(&lt;markerState&gt;, [x1, x2, ...], [y1, y2, ...})
Description
Draws one or more markers at the points described either by lists or matrices. The optional
markerState argument sets the type of marker.
Marker Size(n)
Description
Sets the size used for markers.
Mousetrap(dragscript, mouseupscript)
Description
Captures click coordinates to update graph properties. The first script is executed at drag
and the second at mouseup.
Normal Contour(prob, meanMatrix, stdMatrix, corrMatrix, &lt;colorsMatrix&gt;,
&lt;fill=x&gt;)
Description
Draws normal probability contours for k populations and two variables.
Arguments
prob A scalar or matrix of probabilities.
meanMatrix A matrix of means of size k by 2.
stdMatrix A matrix of standard deviations of size k by 2.
corrMatrix A matrix of correlations of size k by 1.
130
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
colorsMatrix Optional. Specifies the color(s) for the k contour(s). The colors must be
specified as JSL colors (either JSL color integer values or return values of JSL Color
functions such as RGB Color or HLS Color).
fill=x Optional. Specifies the amount of transparency for the contour fill color.
Oval(x1, y1, x2, y2, &lt;fill&gt;)
Oval({x1, y1}, {x2, y2}, &lt;fill&gt;)
Description
Draws an oval inside the rectangle whose diagonal has the coordinates (x1, y1) and (x2, y2).
Fill is Boolean. If fill is 0, the oval is empty. If fill is nonzero, the oval is filled with the
current fill color. The default value for fill is 0.
Path(path, &lt;fill&gt;)
Description
Draws a stroke along the given path. If a fill is specified, the interior of the path is filled
with the current fill color.
Argument
path Can be either an Nx3 matrix or a string that contains SVG syntax.
fill An optional, Boolean argument that specifies whether a line is drawn (0) or the path
is filled (1). The default value is 0.
Note
A path matrix has three columns, for x and y, and a flag. The flag value for each point can
be 0 for control, 1 for move, 2 for line segment, 3 for cubic B&eacute;zier segment, and any negative
value to close the path.
Path To Char(path)
Description
Converts a path specification from a matrix to a string.
Returns
A string.
Argument
path An Nx3 path matrix.
Note
A path matrix has three columns, for x and y, and a flag. The flag value for each point can
be 0 for control, 1 for move, 2 for line segment, 3 for cubic B&eacute;zier segment, and any negative
value to close the path.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
131
Pen Color(n)
Description
Sets the color used for the pen.
Pen Size(n)
Description
Sets the thickness of the pen in pixels.
Pie(x1, y1, x2, y2, startangle, endangle)
Description
Draws a filled pie slice. The two points describe a rectangle, within which is a virtual oval.
Only the slice described by the start and end angles is drawn.
Pixel Line To(x, y)
Description
Draws a one‐pixel‐wide line from the current pixel location to the location given in pixel
coordinates. Set the current pixel location using the Pixel Origin and Pixel Move To
commands.
Pixel Move To(x, y)
Description
Moves the current pixel location to a new location given in pixel coordinates.
Pixel Origin(x, y)
Description
Sets the origin, in graph coordinates, for subsequent Pixel Line To or Pixel Move To
commands.
Polygon({x1, y1}, {x2, y2}, ...)
Polygon(xmatrix, ymatrix)
Description
Draws a filled polygon defined by the listed points.
132
JSL Functions
Graphic Functions
Chapter 2
JSL Syntax Reference
Rect(x1, y1, x2, y2, &lt;fill&gt;)
Rect({x1, y1}, {x2, y2}, &lt;fill&gt;)
Description
Draws a rectangle whose diagonal has the coordinates (x1, y1) and (x2, y2). Fill is Boolean.
If fill is 0, the rectangle is empty. If fill is nonzero, the rectangle is filled with the current
fill color. The default value for fill is 0.
RGB Color(r, g, b)
RGB Color({r, g, b})
Description
Converts red, green, and blue values into a JMP color number.
Returns
An integer that is a JMP color number.
Arguments
Red, green, and blue, or a list containing the three RGB values. All values should be
between 0 and 1.
Text(&lt;properties&gt;, ({x, y}|{left, bottom, right, top}), &quot;text&quot;)
Description
Draws the quoted string text at the given point, either the x and y axes or the left, bottom,
right, and top axes.
Properties can be any of several named arguments: Center Justified, Right Justified,
Erased, Boxed, Counterclockwise, Position, and named arguments. The position, named
arguments, and strings can be added in any order. The position and named arguments
apply to all the strings.
Text Color(n)
Description
Sets the color for Text strings.
Text Size(n)
Description
Sets the font size in points for Text strings.
Chapter 2
JSL Syntax Reference
JSL Functions
Graphic Functions
133
Transparency(alpha)
Description
Sets the transparency of the current drawing, with alpha between 0 and 1 where 0 is clear
(no drawing) and 1 is completely opaque (the default).
Note
Not all operating systems support transparency.
V Line(x, &lt;y1, y2&gt;)
Description
Draws a vertical line at x across the graph. If you specify start and end points on the y‐axis
(y1 and y2), the line is drawn vertically at x from y1 to y2. You can also draw multiple lines
by using a matrix of values in the x argument.
V Size()
Description
Returns the vertical size of the graphics frame in pixels
X Function(expr, symbol, &lt;Min(min), Max(max), Fill(value), Inc(bound), Show
Details(n)&gt;)
Description
Draws a plot of the function as the symbol is varied over the y‐axis of the graph.
X Origin()
Description
Returns the x‐value for the left edge of the graphics frame
X Range()
Description
Returns the distance from the left to right edge of the display box. For example, X Origin()
+ X Range() is the right edge.
X Scale(xmin, xmax)
Description
Sets the range for the horizontal scale. The default value for xmin is 0, and the default value
for xmax is 100.
134
JSL Functions
MATLAB Integration Functions
Chapter 2
JSL Syntax Reference
Y Function(expr, symbol, &lt;Min(min), Max(max), Fill(value), Inc(bound), Show
Details(n)&gt;)
Description
Draws a plot of the function as the symbol is varied over the x‐ axis of the graph.
Y Origin()
Description
Returns the y‐value for the bottom edge of the graphics frame
Y Range()
Description
Returns the distance from the bottom to top edges of a display box. For example,
Y Origin() + Y Range() is the top edge.
Y Scale(ymin, ymax)
Description
Sets the range for the vertical scale. If you do not specify a scale, it defaults to (0, 100).
MATLAB Integration Functions
JMP provides the following interfaces to access MATLAB. The basic execution model is to first
initialize the MATLAB connection, perform the required MATLAB operations, and then
terminate the MATLAB connection. In most cases, these functions return 0 if the MATLAB
operation was successful or an error code if it was not. If the MATLAB operation is not
successful, a message is written to the Log window. The single exception to this is MATLAB
Get( ), which returns a value.
See Scripting Guide for details on working with MATLAB.
MATLAB JSL Function Interfaces
MATLAB Connect( &lt;named arguments&gt; )
Description
Initializes the MATLAB integration interfaces and returns an active MATLAB integration
interface connection as a scriptable object.
Returns
MATLAB scriptable object.
Chapter 2
JSL Syntax Reference
JSL Functions
MATLAB Integration Functions
135
Named Arguments
Echo(Boolean) Sends the MATLAB source lines to the JMP log. The default value is true.
MATLAB Control( &lt;named arguments&gt; )
Description
Sends control operations to signal MATLAB with external events such as source line
echoing.
Returns
None.
Arguments
None.
Named Arguments
Echo(Boolean) Global. Echo MATLAB source lines to the JMP log.
Visible(Boolean) Global. Determine whether to show or hide the active MATLAB
workspace.
MATLAB Execute( { list of inputs }, { list of outputs }, mCode, &lt;named
arguments&gt; )
Description
Submits the MATLAB code to the active global MATLAB connection given a list of inputs.
Upon completion, retrieves a list of outputs.
Returns
0 if successful, otherwise nonzero.
Arguments
{ list of inputs } Positional, name list. List of JMP variable names to send to
MATLAB as inputs.
{ list of outputs } Positional, name list. List of JMP variable names to retrieve from
MATLAB as outputs.
mCode Positional, string. The MATLAB code to submit.
Named Arguments
Expand(Boolean) Perform an Eval Insert on the MATLAB code prior to submission.
Echo(Boolean) Echo MATLAB source lines to the JMP log. Default is true.
Example
The following example sends the JMP variables x and y to MATLAB, executes the MATLAB
statement z = x * y, and then gets the MATLAB variable z and returns it to JMP.
x = [1 2 3];
mc = MATLAB Send( x );
136
JSL Functions
MATLAB Integration Functions
Chapter 2
JSL Syntax Reference
y = [4 5 6];
mc = MATLAB Send( y );
mc = MATLAB Execute( {x, y}, {z}, &quot;z = x * y;&quot; );
MATLAB Get( name )
Description
Gets named variable from MATLAB to JMP.
Returns
Value of named variable.
Arguments
name Positional. The name of a JMP variable to be sent to MATLAB.
Example
Suppose that a matrix named qbx and a structure named df are present in your MATLAB
connection.
// Get the MATLAB variable qbx and placed it into a JMP variable qbx.
qbx = MATLAB Get( qbx );
// Get the MATLAB variable df and placed it into a JMP data table referenced
by df.
df = MATLAB Get( df );
Table 2.1 shows what JMP data types can be exchanged with MATLAB using the MATLAB
Get( ) function. Getting lists from MATLAB recursively examines each element of the list and
sends each base MATLAB data type. Nested lists are supported.
Table 2.1 JMP and MATLAB Equivalent Data Types for MATLAB Get( )
MATLAB Data Type
JMP Data Type
Double
Numeric
Logical
Numeric ( 0 | 1 )
String
String
Integer
Numeric
Date/Time
Numeric
Structure
Data Table
Matrix
Numeric Matrix
Numeric Vector
Numeric Matrix
Chapter 2
JSL Syntax Reference
JSL Functions
MATLAB Integration Functions
137
Table 2.1 JMP and MATLAB Equivalent Data Types for MATLAB Get( ) (Continued)
MATLAB Data Type
JMP Data Type
String Vector
List of Strings
Graph
Picture object
MATLAB Get Graphics( format )
Description
Get the last graphic object written to the MATLAB graph display window in a specific
graphic format. The graphic object can be returned in several graphic formats.
Returns
JMP Picture object.
Argument
format Positional. The format the MATLAB graph display window contents are to be
converted to. Valid formats are &quot;png&quot;, ʺbmpʺ, ʺjpegʺ, ʺjpgʺ, ʺtiffʺ, and ʺtifʺ.
MATLAB Init( &lt;named arguments&gt; )
Description
Initializes the MATLAB integration interfaces.
Returns
Return code.
Named Arguments
Echo(Boolean) Sends MATLAB source lines to the JMP log. This option is global. The
default value is true.
MATLAB Is Connected()
Description
Determines whether a MATLAB connection is active.
Returns
1 if connected, otherwise 0.
MATLAB JMP Name To MATLAB Name( name )
Description
Maps a JMP variable name to its corresponding MATLAB variable name using MATLAB
variable name naming rules.
138
JSL Functions
MATLAB Integration Functions
Chapter 2
JSL Syntax Reference
Returns
String, mapped MATLAB variable name.
Argument
name Positional. The name of a JMP variable to be sent to MATLAB.
MATLAB Send( name, &lt;named arguments&gt; )
Description
Sends the named variable from JMP to MATLAB.
Returns
0 if successful, otherwise nonzero.
Arguments
name Positional. The name of a JMP variable to be sent to MATLAB.
Named Arguments
The following optional arguments apply to data tables only:
Selected(Boolean) Send selected rows from the referenced data table to MATLAB.
Excluded(Boolean) Send only excluded rows from the referenced data table to MATLAB.
Labeled(Boolean) Send only labeled rows from the referenced data table to MATLAB.
Hidden(Boolean) Send only hidden rows from the referenced data table to MATLAB.
Colored(Boolean) Send only colored rows from the referenced data table to MATLAB.
Markered(Boolean) Send only markered rows from the referenced data table to
MATLAB.
Row States(Boolean, &lt;named arguments&gt;) Send row states from referenced data table
to MATLAB by adding an additional data column named “RowState”. Create multiple
selections by adding together individual settings. The row state consists of individual
settings with the following values:
‒ Selected = 1
‒ Excluded = 2
‒ Labeled = 4
‒ Hidden = 8
‒ Colored = 16
‒ Markered = 32
The following optional, named Row States arguments are supported:
Colors(Boolean) Send row colors. Adds additional data column named
“RowStateColor”.
Chapter 2
JSL Syntax Reference
JSL Functions
MATLAB Integration Functions
139
Markers(Boolean) Send row markers. Adds additional data column named
“RowStateMarker”.
Example
// Create a matrix, assign it to X, and send the matrix to MATLAB.
X = [1 2 3];
ml = MATLAB Send( X );
// Open a data table, assign a reference to it to dt, and send the data table
along with its current row states to MATLAB.
dt = Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
ml = MATLAB Send( dt, Row States(1) );
Table 2.2 shows what JMP data types can be exchanged with MATLAB using the MATLAB
Send( ) function. Sending lists to MATLAB recursively examines each element of the list and
sends each base JMP data type. Nested lists are supported.
Table 2.2 JMP and MATLAB Equivalent Data Types for MATLAB Send( )
MATLAB Data Type
JMP Data Type
Double
Numeric
String
String
Double Matrix
Matrix
Structure
Data Table
Example
MATLAB Init( );
X = 1;
MATLAB Send( X );
S = &quot;Report Title&quot;;
MATLAB Send( S );
M = [1 2 3, 4 5 6, 7 8 9];
MATLAB Send( M );
MATLAB Submit( &quot;
X
S
M
&quot; );
MATLAB Term( );
140
JSL Functions
MATLAB Integration Functions
Chapter 2
JSL Syntax Reference
MATLAB Submit File( ’pathname’, &lt;named arguments&gt; )
Description
Submits statements to MATLAB using a file pointed to by pathname.
Returns
0 if successful, otherwise nonzero.
Arguments
Pathname Positional, string. Pathname to file containing MATLAB source lines to be
executed.
Named Arguments
Expand(Boolean) Perform an Eval Insert on the MATLAB code prior to submission.
Echo(Boolean) Echo MATLAB source lines to the JMP log. Default is true.
MATLAB Submit( mCode, &lt;named arguments&gt; )
Description
Submits the MATLAB code to the active global MATLAB connection.
Returns
0 if successful, otherwise nonzero.
Arguments
mCode Positional, string. The MATLAB code to submit.
Named Arguments
Expand(Boolean) Perform an Eval Insert on the MATLAB code prior to submission.
Echo(Boolean) Echo MATLAB source lines to the JMP log. Default is true.
Example
The following example creates two vectors of random points and plots them as x and y
variables.
mc = MATLAB Submit(&quot;\[
x = rand(5);
fprintf('%f\n', x);
y = rand(5);
fprintf('%f\n', x);
z = plot(x, y);
]\&quot; );
MATLAB Term();
Description
Terminates the currently active MATLAB integration interface.
Chapter 2
JSL Syntax Reference
JSL Functions
MATLAB Integration Functions
141
Returns
1 if an active MATLAB connection exists, otherwise returns 0.
Arguments
None.
MATLAB JSL Scriptable Object Interfaces
The MATLAB interfaces are also scriptable using a MATLAB connection object. Use the
MATLAB Connect() JSL function to obtain a scriptable MATLAB connection object.
mlconn &lt;&lt; Control( &lt;named arguments&gt; )
Controls the execution of MATLAB.
Returns
None.
Named Arguments
Echo(Boolean) Global. Echo MATLAB source lines to the JMP Log window.
Visible(Boolean) Global. Determine whether to show or hide the active MATLAB
workspace.
mlconn &lt;&lt; Disconnect()
Description
Disconnects this MATLAB integration interface connection.
mlconn &lt;&lt; Execute( { list of inputs }, { list of outputs }, mCode, &lt;named
arguments&gt; )
Submits MATLAB code to the active global MATLAB integration interface connection
given a list of inputs and upon completion a list of outputs are retrieved.
Returns
0 if successful, otherwise nonzero.
Arguments
{ list of inputs } Positional, name list. List of JMP variable names to be sent to
MATLAB as inputs.
{ list of outputs } Positional, name list. List of JMP variable names to be retrieved
from MATLAB as outputs.
mCode Positional, string. The MATLAB code to submit.
Named Arguments
Expand(Boolean) Perform an Eval Insert on the MATLAB code prior to submission.
142
JSL Functions
MATLAB Integration Functions
Chapter 2
JSL Syntax Reference
Echo(Boolean) Echo MATLAB source lines to the JMP Log window. Default is true.
mlconn &lt;&lt; Get Graphics( format )
Gets the last graphic object written to the MATLAB graph display window. The graphic
object can be returned in several graphic formats.
Returns
JMP Picture object.
Arguments
format Positional. The format the MATLAB graph display window contents are to be
converted to. Valid formats are &quot;png&quot;, ʺbmpʺ, ʺjpegʺ, ʺjpgʺ, ʺtiffʺ, and ʺtifʺ.
mlconn &lt;&lt; Get Version()
Gets the current version of the installed MATLAB.
Returns
Matrix, returns a vector of length 3 containing the MATLAB version number.
Arguments
None.
mlconn &lt;&lt; Get( name )
Description
Gets a named variable from MATLAB to JMP.
Returns
Value of named variable.
Arguments
name Positional. The name of a JMP variable to be retrieved from MATLAB.
mlconn &lt;&lt; Is Connected()
Description
Determines whether connection is active.
Returns
1 if connected, otherwise 0.
Arguments
None.
Chapter 2
JSL Syntax Reference
JSL Functions
MATLAB Integration Functions
143
mlconn &lt;&lt; JMP Name To MATLAB Name( JMP name)
Maps a JMP variable name to its corresponding MATLAB variable name using MATLAB
variable name naming rules.
Returns
String, a mapped MATLAB name.
Arguments
names Positional. The name of a JMP variable to be sent to MATLAB.
mlconn &lt;&lt; Send( name, &lt;named arguments&gt; )
Description
Sends the named variable from JMP to MATLAB.
Returns
0 if successful, otherwise nonzero.
Arguments
name Positional. The name of a JMP variable to be sent to MATLAB.
Named Arguments
The following arguments are for data tables only:
Selected(Boolean) Send selected rows from the referenced data table to MATLAB.
Excluded(Boolean) Send only excluded rows from the referenced data table to MATLAB.
Labeled(Boolean) Send only labeled rows from the referenced data table to MATLAB.
Hidden(Boolean) Send only hidden rows from the referenced data table to MATLAB.
Colored(Boolean) Send only colored rows from the referenced data table to MATLAB.
Markered(Boolean) Send only markered rows from the referenced data table to
MATLAB.
Row States (Boolean, &lt;named arguments&gt;) Send row states from referenced data
table to MATLAB by adding an additional data column named “RowState”. Create
multiple selections by adding together individual settings. The row state consists of
individual settings with the following values:
‒ Selected = 1
‒ Excluded = 2
‒ Labeled = 4
‒ Hidden = 8
‒ Colored = 16
‒ Markered = 32
The following optional, named Row States arguments are supported:
144
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Colors(Boolean) Send row colors. Adds additional data column named
“RowStateColor”.
Markers(Boolean) Send row markers. Adds additional data column named
“RowStateMarker”.
mlconn &lt;&lt; Submit( mCode, &lt;named arguments&gt; )
Submits MATLAB code to the active global MATLAB integration interface connection.
Returns
0 if successful, otherwise nonzero.
Arguments
mCode Positional, string. The MATLAB code to submit.
Named Arguments
Expand(Boolean) Perform an Eval Insert on the MATLAB code prior to submission.
Echo(Boolean) Echo MATLAB source lines to the JMP log. Default is true.
mlconn &lt;&lt; Submit File( pathname )
Submits statements to MATLAB using a file pointed to by pathname.
Returns
0 if successful, otherwise nonzero.
Arguments
Pathname Positional, string. Pathname to file containing MATLAB source lines to be
executed.
Matrix Functions
All(A, ...)
Returns
1 if all matrix arguments are nonzero; 0 otherwise.
Any(A, ...)
Returns
1 if one or more elements of one or more matrices are nonzero; 0 otherwise.
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
145
CDF(Y)
Description
Returns values of the empirical cumulative probability distribution function for Y, which
can be a vector or a list. Cumulative probability is the proportion of data values less than or
equal to the value of QuantVec.
Syntax
{QuantVec, CumProbVec} = CDF(YVec)
Chol Update(L, V, C)
Description
If L is the Cholesky root of an nxn matrix A, then after calling cholUpdate L is replaced with
the Cholesky root of A+V*C*Vʹ where C is an mxm symmetric matrix and V is an n*m matrix.
Cholesky(A)
Description
Finds the lower Cholesky root (L) of a positive semi‐definitive matrix, L*Lʹ = A.
Returns
L (the Cholesky root).
Arguments
A a symmetric matrix.
Correlation(matrix)
Description
Calculates the correlation matrix of the data in the matrix argument.
Returns
The correlation matrix for the specified matrix.
Argument
matrix A matrix that contains the data. If the data has m rows and n columns, the result is
an m‐by‐m matrix.
Notes
Rows are discarded if they contain missing values.
This function uses multithreading if available, so it is recommended for large problems
with many rows.
When a column is constant, the correlations for it are 0, and the diagonal element is also 0.
146
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Covariance(matrix, &lt;,&quot;Pairwise&quot;&gt;, &lt;,&quot;Shrink&quot;&gt;
Description
Calculates the covariance matrix of the data in the matrix argument.
Returns
The covariance matrix for the specified matrix.
Argument
matrix A matrix that contains the data. If the data has m rows and n columns, the result is
an m‐by‐n matrix.
&quot;Pairwise&quot; Performs pairwise covariances rather than row‐wise covariances.
&quot;Shrink&quot; Performs the Schafer‐Strimmer shrinkage estimate.
Notes
Rows are discarded if they contain missing values.
This function uses multithreading if available, so it is recommended for large problems
with many rows.
Design(vector, &lt; levelsList | &lt;&lt;levels &gt;)
Description
Creates design columns for a vector of values.
Returns
A design matrix with a column of 1s and 0s for each unique value of the argument or a list
that contains the design matrix and a list of levels.
Argument
vector a vector.
levelsList An optional argument that is a list or matrix specifying the levels in the
returned matrix.
&lt;&lt;levels An optional argument that changes the return value to a list that contains the
design matrix and a list of levels.
Note
Missing values in the levelsList argument are not ignored. For example:
Show(Design ( ., [. 0 1] ),
Design ( 0, [. 0 1] ),
Design ( 1, [. 0 1] ),
Design ( [0 0 1 . 1], [. 0 1] ),
Design ( {0, 0, 1, ., 1}, [. 0 1] ) );
Design(., [. 0 1]) = [1 0 0];
Design(0, [. 0 1]) = [0 1 0];
Design(1, [. 0 1]) = [0 0 1];
Design([0 0 1 . 1], [. 0 1]) =
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
147
[ 0 1 0,
0 1 0,
0 0 1,
1 0 0,
0 0 1];
Design({0, 0, 1, ., 1}, [. 0 1]) =
[ 0 1 0,
0 1 0,
0 0 1,
1 0 0,
0 0 1];
Design Nom(vector, &lt; levelsList | &lt;&lt;levels &gt;)
DesignF(vector, &lt; &lt;&lt;levels &gt;)
Description
A version of Design for making full‐rank versions of design matrices for nominal effects.
Returns
A full‐rank design matrix or a list that contains the design matrix and a list of levels.
Argument
vector A vector.
levelsList An optional argument that is a list or matrix specifying the levels in the
returned matrix.
&lt;&lt;levels An optional argument that changes the return value to a list that contains the
design matrix and a list of levels.
Note
Missing values in the levelsList argument are not ignored. For example:
Show( Design Nom( ., [. 0 1] ),
Design Nom( 0, [. 0 1] ),
Design Nom( 1, [. 0 1] ),
Design Nom( [0 0 1 . 1], [. 0 1] ),
Design Nom( {0, 0, 1, ., 1}, [. 0 1] ) );
Design Nom(., [. 0 1]) = [1 0];
Design Nom(0, [. 0 1]) = [0 1];
Design Nom(1, [. 0 1]) = [-1 -1];
Design Nom([0 0 1 . 1], [. 0 1]) = [0 1, 0 1, -1 -1, 1 0, -1 -1];
Design Nom({0, 0, 1, ., 1}, [. 0 1]) = [0 1, 0 1, -1 -1, 1 0, -1 -1];
Design Ord(vector, &lt; levelsList | &lt;&lt;levels &gt;)
Description
A version of Design for making full‐rank versions of design matrices for ordinal effects.
Returns
A full‐rank design matrix or a list that contains the design matrix and a list of levels.
148
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Argument
vector A vector.
levelsList An optional argument that is a list or matrix specifying the levels in the
returned matrix.
&lt;&lt;levels An optional argument that changes the return value to a list that contains the
design matrix and a list of levels.
Note
Missing values in the levelsList argument are not ignored. For example:
Show(Design Ord( ., [. 0 1] ),
Design Ord( 0, [. 0 1] ),
Design Ord( 1, [. 0 1] ),
Design Ord( [0 0 1 . 1], [. 0 1] ),
Design Ord( {0, 0, 1, ., 1}, [. 0 1] ) );
Design Ord(., [. 0 1]) = [0 0];
Design Ord(0, [. 0 1]) = [1 0];
Design Ord(1, [. 0 1]) = [1 1];
Design Ord([0 0 1 . 1], [. 0 1]) = [1 0, 1 0, 1 1, 0 0, 1 1];
Design Ord({0, 0, 1, ., 1}, [. 0 1]) = [1 0, 1 0, 1 1, 0 0, 1 1];
DesignF()
See “Design Nom(vector, &lt; levelsList | &lt;&lt;levels &gt;)” on page 147.
Det(A)
Description
Determinant of a square matrix.
Returns
The determinant.
Argument
A A square matrix.
Diag(A, &lt;B&gt;)
Description
Creates a diagonal matrix from a square matrix or a vector. If two matrices are provided,
concatenates the matrices diagonally.
Returns
The matrix.
Argument
A a matrix or a vector.
Chapter 2
JSL Syntax Reference
Direct Product(A, B)
Description
Direct (Kronecker) product of square matrices or scalars A[i,j]*B.
Returns
The product.
Arguments
A, B Square matrices or scalars.
Distance(x1, x2, &lt;scales&gt;, &lt;powers&gt;)
Description
Produces a matrix of distances between rows of x1 and rows of x2.
Returns
A matrix.
Arguments
x1, x2 Two matrices.
scales Optional argument to customize the scaling of the matrix.
powers Optional argument to customize the powers of the matrix.
E Div(A, B)
A/B
Description
Element‐by‐element division of two matrices.
Returns
The resulting matrix.
Arguments
A, B Two matrices.
E Mult(A, B)
A*B
Description
Element‐by‐element multiplication of two matrices.
Returns
The resulting matrix.
Arguments
A, B Two matrices.
JSL Functions
Matrix Functions
149
150
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Eigen(A)
Description
Eigenvalue decomposition.
Returns
A list {M, E} such that E * Diag(M) * E = A'.
Argument
A A symmetric matrix.
G Inverse(A)
Description
Generalized (Moore‐Penrose) matrix inverse.
H Direct Product(A, B)
Description
Horizontal direct product of two square matrices of the same dimension or scalars.
Hough Line Transform(matrix, &lt;NAngle(number)&gt;, &lt;NRadius(number)&gt;)
Description
Takes a matrix of intensities and transforms it in a way that is useful for finding streaks in
the matrix. Produces a matrix containing the Hough Line Transform with angles as
columns and radiuses as rows.
Argument
matrix A matrix that can be derived from the intensities of an image, but is more likely
from a semiconductor wafer that may have defects across in a streak due to
planarization machines.
NAngle(number) Enter the number of the angle to obtain a different sized transform. The
default is 180 degrees.
NRadius(number) Enter the number of the radius to obtain a different sized transform.
The default is sqrt(NRow*nRow+nCol*nCol).
Identity(n)
Description
Creates an n‐by‐n identity matrix with ones on the diagonal and zeros elsewhere.
Returns
The matrix.
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
151
Argument
n An integer.
Index(i, j, &lt;increment&gt;)
i::j
Description
Creates a column matrix whose values range from i to j.
Returns
The matrix.
Arguments
i, j Integers that define the range: i is the beginning of the range, j is the end.
increment Optional argument to change the default increment, which is +1.
Inv()
See “Inverse(A)” on page 151.
Inv Update(A, X, 1|-1)
Description
Efficiently update an X&acute;X matrix.
Arguments
A The matrix to be updated.
X One or more rows to be added to or deleted from the matrix A.
1|-1 The third argument controls whether the row or rows defined in the second
argument, X, are added to or deleted from the matrix A. 1 means to add the row or rows
and -1 means to delete the row or rows.
Inverse(A)
Inv(A)
Description
Returns the matrix inverse. The matrix must be square non‐singular.
Is Matrix(x)
Description
Returns 1 if the evaluated argument is a matrix, or 0 otherwise.
152
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
J(nrows, &lt;ncols&gt;, &lt;value&gt;)
Description
Creates a matrix of identical values.
Returns
The matrix.
Arguments
nrows Number of rows in matrix. If ncols is not specified, nrows is also used as ncols.
ncols Number of columns in matrix.
value The value used to populate the matrix. If value is not specified, 1 is used.
KDTable(matrix)
Description
Returns a table to efficiently look up near neighbors.
Returns
A KDTable object.
Argument
matrix A matrix of k‐dimensional points. The number of dimensions or points is not
limited. Each column in the matrix represents a dimension to the data, and each row
represents a data point.
Messages
&lt;&lt;Distance between rows(row1, row2) Returns the distance between two the two
specified rows in the KDTable. The distance applies to removed and inserted rows as
well.
&lt;&lt;K nearest rows(stop, &lt;position&gt;) Returns a matrix. If position is not specified,
returns the n nearest rows and distances to all rows. If position is specified, returns the
n nearest rows and distances to either a point or a row. Stop is either n or {n, limit}.
Position is a point that is described as a row vector for the coordinate of a row, or as the
number of a row.
&lt;&lt;Remove rows(number | vector) Remove either the row specified by number or the
rows specified by vector. Returns the number of rows that were removed. Rows that
were already removed are ignored.
&lt;&lt;Insert rows(number | vector) Re‐insert either the row specified by number or the
rows specified by vector. Returns the number of rows that were inserted. Rows that
were already inserted are ignored.
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
153
Note
When rows are removed or inserted, the row indices do not change. You can remove and
re‐insert only rows that are in the KDTable object. If you need different rows, construct a
new KDTable.
Loc(A)
Loc(list, item)
Description
Creates a matrix of subscript positions where A is nonzero and nonmissing. For the
two‐argument function, Loc returns a matrix of positions where item is found within list.
Returns
The new matrix.
Argument
A a matrix
list a list
item the item to be found within the list
Loc Max(A)
Description
Returns the position of the minimum element in a matrix.
Returns
An integer that is the specified position.
Argument
A a matrix
Loc Min(A)
Description
Returns the position of the minimum element in a matrix.
Returns
An integer that is the specified position.
Argument
A a matrix
154
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Loc NonMissing(matrix, ..., {list}, ...)
Description
Returns indices of nonmissing rows in matrices or lists. In lists, the function can also return
indices of nonempty characters.
Returns
The new matrix or list.
Loc Sorted(A, B)
Description
Creates a matrix of subscript positions where the values of A have values less than or equal
to the values in B. A must be a matrix sorted in ascending order.
Returns
The new matrix.
Argument
A, B matrices
Matrix({{x11, x12, ..., x1m}, {x21, x22, ..., 2m}, {...}, {xn1, xn2, ...,
xnm}})
Description
Constructs an n‐by‐m matrix from a list of n lists of m row values or from the number of rows
and columns.
Returns
The matrix.
Arguments
A list of lists in which each list forms a row with the specified values.
Example
mymatrix = matrix({{1, 2, 3}, {4, 5, 6}, {7, 8, 9}, {10, 11, 12}});
[ 1 2 3,
4 5 6,
7 8 9,
10 11 12]
Equivalent Expression
[x11 x12 ... x1m,
...,
xn1 xn2 ... xnm ]
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
155
Matrix Mult(A, B)
C=A*B, ...
Description
Matrix multiplication.
Arguments
Two or more matrices, which must be conformable (all matrices after the first one listed
must have the same number of rows as the number of columns in the first matrix).
Note
Matrix Mult() allows only two arguments, while using the * operator enables you to
multiply several matrices.
Mode(list or matrix)
Description
Selects the most frequent item from a numeric or character list or a numeric matrix. In the
event of a tie, the lower value is selected.
Note: A combination of numeric and character values is not supported in a list. All values
must be either numeric or character.
Arguments
Specify either a list or a matrix.
Multivariate Normal Impute(yVec, meanYvec, symCovMat)
Description
Imputes missing values in yVec based on the mean and covariance.
Arguments
yVec The vector of responses.
meanYvec The vector of response means.
symCovMat A symmetric matrix containing the response covariances. If the covariance
matrix is not specified, then JMP imputes with means.
NChooseK Matrix(n, k)
Description
Returns a matrix of n things taken k at a time (n select k).
156
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
N Col(x)
N Cols(x)
Description
Returns the number of columns in either a data table or a matrix.
Argument
x Can be a data table or a matrix.
Ortho(A, &lt;Centered(0)&gt;, &lt;Scaled(1)&gt;)
Description
Orthonormalizes the columns of matrix A using the Gram Schmidt method. Centered(0)
makes the columns to sum to zero. Scaled(1) makes them unit length.
Ortho Poly(vector, order)
Description
Returns orthogonal polynomials for a vector of indices representing spacings up to the
order given.
Print Matrix(M, &lt;named arguments&gt;)
Description
Returns a string that contains a well‐formatted matrix. You can use the function, for
example, to print the matrix to the log.
Argument
M A matrix.
Named Arguments
Note that the following named arguments are all optional.
&lt;&lt;ignore locale(Boolean) Set to false (0) to use the decimal separator for your locale.
Set to true (1) to always use a period (.) as a separator. The default value is false (0).
&lt;&lt;decimal digits(n) An integer that specifies the number of digits after the decimal
separator to print.
&lt;&lt;style(&quot;style name&quot;) Use one of three available styles: Parseable is a reformatted JSL
matrix expression. Latex is formatted for LaTex. If you specify Other, you must define
the following three arguments.
&lt;&lt;separate(&quot;character&quot;) Define the separator for concatenated entries.
&lt;&lt;line begin(&quot;character&quot;) Define the beginning line character.
&lt;&lt;line end(&quot;character&quot;) Define the ending line character.
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
157
QR(A)
Description
Returns the QR decomposition of A. Typical usage is {Q, R} = QR(A).
Rank Index(vector)
Rank(vector)
Description
Returns a vector of indices that, used as a subscript to the original vector, sorts the vector
by rank. Excludes missing values. Lists of numbers or strings are supported in addition to
matrices.
Ranking(vector)
Description
Returns a vector of ranks of the values of vector, low to high as 1 to n, ties arbitrary. Lists of
numbers or strings are supported in addition to matrices.
Ranking Tie(vector)
Description
Returns a vector of ranks of the values of vector, but ranks for ties are averaged. Lists of
numbers or strings are supported in addition to matrices.
Shape(A, nrow, &lt;ncol&gt;)
Description
Reshapes the matrix A across rows to the specified dimensions. Each value from the matrix
A is placed row‐by‐row into the re‐shaped matrix.
Returns
The reshaped matrix.
Arguments
A a matrix
nrow the number of rows that the new matrix should have.
ncol optional. The number of columns the new matrix should have.
Notes
If ncol is not specified, the number of columns is whatever is necessary to fit all of the
original values of the matrix into the reshaped matrix.
If the new matrix is smaller than the original matrix, the extra values are discarded.
158
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
If the new matrix is larger than the original matrix, the values are repeated to fill the new
matrix.
Examples
a = matrix({ {1, 2, 3}, {4, 5, 6}, {7, 8, 9} });
[ 1 2 3,
4 5 6,
7 8 9]
shape(a, 2);
[ 1 2 3 4 5,
6 7 8 9 1]
shape(a, 2, 2);
[ 1 2,
3 4]
shape(a,
[ 1 2
5 6
9 1
4 5
4, 4);
3 4,
7 8,
2 3,
6 7]
Solve(A, b)
Description
Solves a linear system. In other words, x=inverse(A)*b.
Sort Ascending(source)
Description
Returns a copy of a list or matrix source with the items in ascending order.
Sort Descending(source)
Description
Returns a copy of a list or matrix source with the items in descending order.
Spline Coef(x, y, lambda)
Description
Returns a five column matrix of the form knots||a||b||c||d where knots is the unique
values in x.
Chapter 2
JSL Syntax Reference
JSL Functions
Matrix Functions
159
Spline Eval(x, coef)
Description
Evaluates the spline predictions using the coef matrix, where coef is in the same form as
Spline Coef().
Spline Smooth(x, y, lambda)
Description
Returns the smoothed predicted values from a spline fit.
SVD(A)
Description
Singular value decomposition.
Sweep(A, &lt;indices&gt;)
Description
Sweeps, or inverts a matrix a partition at a time.
Trace(A)
Description
The trace, or the sum of the diagonal elements of a square matrix.
Transpose(A)
Description
Transposes the rows and columns of the matrix A.
Returns
The transposed matrix.
Arguments
A A matrix.
Equivalent Expression
A‘
V Concat(A, B, ...)
Description
Vertical concatenation of two or more matrices.
160
JSL Functions
Matrix Functions
Chapter 2
JSL Syntax Reference
Returns
The new matrix.
Arguments
Two or more matrices.
V Concat To(A, B, ...)
Description
Vertical concatenation in place. This is an assignment operator.
Returns
The new matrix.
Arguments
Two or more matrices.
V Max(matrix)
Description
Returns a row vector containing the maximum of each column of matrix.
V Mean(matrix)
Description
Returns a row vector containing the mean of each column of matrix.
V Min(matrix)
Description
Returns a row vector containing the minimum of each column of matrix.
V Standardize(matrix)
Description
Returns a matrix column‐standardized to mean = 0 and standard deviation = 1.
V Std(matrix)
Description
Returns a row vector containing the standard deviations of each column of matrix.
V Sum(matrix)
Description
Returns a row vector containing the sum of each column of matrix.
Chapter 2
JSL Syntax Reference
JSL Functions
Numeric Functions
Vec Diag(A)
Description
Creates a vector from the diagonals of a square matrix A.
Returns
The new matrix.
Arguments
A square matrix.
Note
Using a matrix that is not square results in an error.
Vec Quadratic(symmetric matrix, rectangular matrix)
Description
Constructs an n‐by‐m matrix. Used in calculation of hat values.
Returns
The new matrix.
Arguments
Two matrices. The first must be symmetric.
Equivalent Expression
Vec Diag(X*Sym*X‘)
Numeric Functions
Abs(n)
Description
Calculates the absolute value of n.
Returns
Returns a positive number of the same magnitude as the value of n.
Argument
n Any number.
Ceiling(n)
Description
If n is not an integer, rounds n to the next highest integer.
Returns
Returns the smallest integer greater than or equal to n.
161
162
JSL Functions
Numeric Functions
Chapter 2
JSL Syntax Reference
Argument
n Any number.
Derivative(expr, {name, ...}, ...)
Description
Calculates the derivative of the expr with respect to name.
Returns
Returns the derivative.
Arguments
expr Any expression. Indirect arguments (for example, Name Expr, Expr, Eval) are
supported.
name Can be a single variable or a list of variables.
Note
Adding an additional variable (derivative(expr, name, name2)) takes the second
derivative.
Floor(n)
Description
If n is not an integer, rounds n to the next lowest integer.
Returns
Returns the largest integer less than or equal to n.
Argument
n Any number.
Examples
Floor(2.7)
2
Floor(–.5)
–1
Invert Expr(expr, name)
Description
Attempts to unfold expr around name.
Mod()
See “Modulo(number, divisor)” on page 163
Chapter 2
JSL Syntax Reference
JSL Functions
Numeric Functions
163
Modulo(number, divisor)
Mod(number, divisor)
Description
Returns the remainder when number is divided by divisor.
Examples
Modulo(6,5)
1
Normal Integrate(muVector, sigmaMatrix, expr, x, nStrata, nSim)
Description
Returns the result of radial‐spherical integration for smooth functions of multivariate,
normally distributed variables.
Arguments
muVector A vector.
sigmaMatrix A matrix.
expr An expression in terms of the variable x.
x The variable used in the expression expr.
nStrata Number of strata.
nSim Number of simulations.
Num Deriv(expr)
Description
Returns the first numeric derivative of the expr with respect to the first argument in the
expression.
Num Deriv2(expr)
Description
Returns the second numeric derivative of the expr with respect to the first argument in the
expression.
Round(n, places)
Description
Rounds n to number of decimal places given.
164
JSL Functions
Optimization Functions
Chapter 2
JSL Syntax Reference
Simplify Expr(expr(expression))
Simplify Expr(nameExpr(global))
Description
Algebraically simplifies an expression
Optimization Functions
Desirability(yVector, desireVector, y)
Description
Fits a function to go through the three points, suitable for defining the desirability of a set of
response variables (y’s). yVector and desireVector are matrices with three values,
corresponding to the three points defining the desirability function. The actual function
depends on whether the desire values are in the shape of a larger‐is‐better, smaller‐is‐better,
target, or antitarget.
Returns
The desirability function.
Arguments
yVector Three input values.
desireVector the corresponding three desirability values.
y the value of which to calculate the desirability.
LPSolve(A, b, c, L, U, neq, nle, nge, &lt;slackVars(Boolean)&gt;)
Description
Returns a list containing the decision variables (and slack variables if applicable) in the first
list item and the optimal objective function value (if one exists) in the second list item.
Arguments
A A matrix of constraint coefficients.
b A matrix that is a column of right hand side values of the constraints.
c A vector of cost coefficients of the objective function.
L, U Matrices of lower and upper bounds for the variables.
neq The number of equality constraints.
nle The number of less than or equal inequalities.
nge The number of greater than or equal inequalities.
slackVars(Boolean) Optional. Determines whether the slack variables are returned in
addition to the decision variables. The default value is 0.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
165
Note
The constraints must be listed as equalities first, less than or equal inequalities next, and
greater than or equal inequalities last.
Maximize(expr, {x1, x2, ...}, messages)
Description
Finds the values for the listed x’s that maximize the expr.
Messages
&lt;&lt;Max Iter(int) An integer that specifies the maximum number of iterations to be
performed.
&lt;&lt;Tolerance(p) p is a number between 0 and 1.
&lt;&lt;Limits(arguments) The arguments specify ranges for each x (for example, x1&lt;3)
Minimize(expr, {x1, x2, ...}, messages)
Description
Finds the values for the listed x’s that minimize the expr.
Messages
&lt;&lt;Max Iter(int) An integer that specifies the maximum number of iterations to be
performed.
&lt;&lt;Tolerance(p) p is a number between 0 and 1.
&lt;&lt;Limits(arguments) The arguments specify ranges for each x (for example, x1&lt;3)
Probability Functions
Beta Density(x, alpha, beta, &lt;theta&gt;, &lt;sigma&gt;)
Description
Calculates the beta probability density function (pdf).
Returns
The density function at quantile x for the beta distribution for the given arguments.
Arguments
x A quantile between theta and theta + sigma. Theta’s default value is 0. Sigma’s default
value is 1.
alpha, beta Shape parameters that must both be greater than 0.
theta optional threshold. The allowable range is –      . The default is 0.
sigma optional scale parameter, which must be greater than 0. The default is 1.
166
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
See Also
The section on probability functions in the Using JMP book.
Beta Distribution(x, alpha, beta, &lt;theta&gt;, &lt;sigma&gt;)
Description
Calculates the cumulative distribution function for the beta distribution.
Returns
Returns the cumulative distribution function at quantile x for the beta distribution with
shape arguments alpha and beta.
Arguments
x A quantile between theta and theta + sigma.
alpha, beta Shape parameters that must both be greater than 0.
theta optional threshold. The allowable range is –      . The default is 0.
sigma optional scale parameter, which must be greater than 0. The default is 1.
See Also
The section on probability functions in the Using JMP book.
Beta Quantile(p, alpha, beta, &lt;theta&gt;, &lt;sigma&gt;)
Description
Calculates the requested quantile for the beta distribution.
Returns
Returns the pth quantile from the beta distribution with shape arguments alpha and beta.
Arguments
p The probability of the quantile desired; p must be between 0 and 1.
alpha, beta Shape parameters that must both be greater than 0.
theta optional threshold. The allowable range is –      . The default is 0.
sigma optional scale parameter, which must be greater than 0. The default is 1.
See Also
The section on probability functions in the Using JMP.
Cauchy Density(q, &lt;center&gt;, &lt;scale&gt;)
Description
Returns the density at q of a Cauchy distribution with center mu and scale sigma.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
167
Cauchy Distribution(q, &lt;center&gt;, &lt;scale&gt;)
Description
Returns the probability that a Cauchy distributed random variable is less than q.
Cauchy Quantile(p, &lt;center&gt;, &lt;scale&gt;)
Description
Returns the quantile from a Cauchy distribution, the value for which the probability is p
that a random value would be lower.
ChiSquare Density(q, df, &lt;center&gt;)
Description
The chi‐square density at q of the chi‐square with df degrees of freedom and optional
non‐centrality parameter center.
Returns
The chi‐square density.
Arguments
q quantile
df degrees of freedom.
center non‐centrality parameter
ChiSquare Distribution(q, df, &lt;center&gt;)
Description
Returns cumulative distribution function at quantile x for chi‐square with df degrees of
freedom centered at center.
ChiSquare Log CDistribution(x, df, &lt;nc&gt;)
Description
Returns 1 ‐ log (value) of the distribution function at quantile x for the chi‐square
distribution.
ChiSquare Log Density(x, df, &lt;nc&gt;)
Description
Returns the log of the value of the density function at quantile x for the chi‐square
distribution
168
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
ChiSquare Log Distribution(x, df, &lt;nc&gt;)
Description
Returns the log of the value of the distribution function at quantile x for the chi‐square
distribution.
ChiSquare Noncentrality(x, df, prob)
Description
Solves the noncentrality such that prob=ChiSquare Distribution (x, df, nc)
ChiSquare Quantile(q, df, &lt;center&gt;)
Description
Returns the pth quantile from the chi‐square distribution with df degrees of freedom,
centered at center.
Dunnett P Value(q, nTrt, dfe, lambdaVec)
Description
Returns the p‐value from Dunnett’s multiple comparisons test.
Returns
A number that is the p‐value.
Arguments
q A number that is the test statistic.
nTrt The number of treatments being compared to the control treatment.
dfe The error degrees of freedom.
lambdaVec A vector of parameters. If lambdaVec is missing (.), the parameters are set to
1/Sqrt(2).
Dunnett Quantile(1-alpha, nTrt, dfe, lambdaVec)
Description
Returns quantile needed in from Dunnett’s multiple comparisons test.
Returns
A number that is the quantile.
Arguments
1-alpha A number that is the confidence level.
nTrt The number of treatments being compared to the control treatment.
dfe The error degrees of freedom.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
169
lambdaVec A vector of parameters. If lambdaVec is missing (.), the parameters are set to
1/Sqrt(2).
F Density(x, dfnum, dfden, &lt;center&gt;)
Description
Returns the F density at x for the F distribution with numerator and denominator degrees
of freedom dfnum and dfden, with optional noncentrality parameter center.
F Distribution(x, dfnum, dfden, &lt;center&gt;)
Description
Returns cumulative distribution function at quantile x for F distribution with numerator
and denominator degrees of freedom dfnum and dfden and noncentrality parameter
center.
F Log CDistribution(x, dfn, dfd, &lt;nc&gt;)
Description
Returns 1 ‐ log (value) of the normal distribution function at quantile x for the F
distribution.
F Log Density(x, dfn, dfd, &lt;nc&gt;)
Description
Returns the log of the value of the density function at quantile x for the F distribution.
F Log Distribution(x, dfn, dfd, &lt;nc&gt;)
Description
Returns the log of the value of the distribution function at quantile x for the F distribution.
F Noncentrality(x, ndf, ddf, prob)
Description
Solves the noncentrality such that prob=F Distribution (x, ndf, ddf, nc)
F Power(alpha, dfh, dfm, d, n)
Description
Calculates the power from a given situation involving an F test or a t test.
170
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
F Quantile(x, dfnum, dfden, &lt;center&gt;)
Description
Returns the pth quantile from the F distribution with numerator and denominator degrees
of freedom dfnum and dfden and noncentrality parameter center.
F Sample Size(alpha, dfh, dfm, d, power)
Description
Calculates the sample size from a given situation involving an F test or a t test.
Frechet Density(x, mu, sigma)
Description
Returns the density at x of a Frechet distribution with location mu and scale sigma.
Arguments
x A number.
mu A location.
sigma The scale.
Frechet Distribution(x, mu, sigma)
Description
Returns the probability that the Fr&eacute;chet distribution with location mu and scale sigma is less
than x.
Arguments
x A number.
mu A location.
sigma The scale.
Frechet Quantile(p, mu, sigma)
Description
Returns the quantile associated with a cumulative probability p for a Fr&eacute;chet distribution
with location mu and scale sigma.
Arguments
p The probability of the quantile desired; p must be between 0 and 1.
mu A location.
sigma The scale.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
171
Gamma Density(q, alpha, &lt;scale&gt;, &lt;threshold&gt;)
Description
Calculates the density at q of a Gamma probability distribution.
Returns
The density function at quantile q for the gamma density distribution for the given
arguments.
Arguments
q A quantile.
alpha Shape parameters that must be greater than 1.
scale Optional scale, which must be greater than 0. The default is 1.
threshold Optional threshold parameter. The allowable range is –      . The default is
0.
See Also
The section on probability functions in the Using JMP.
Gamma Distribution(x, &lt;shape, scale, threshold&gt;)
IGamma(x, &lt;shape, scale, threshold&gt;)
Description
Returns cumulative distribution function at quantile x for the gamma distribution with
shape, scale, and threshold given.
Gamma Log CDistribution(x, alpha, &lt;scale = 1&gt;, &lt;threshold = 0&gt;)
Description
Same as Log (1 – Gamma Distribution(x, alpha)) except that it has a much greater
range.
Gamma Log Density(x, alpha, &lt;scale = 1&gt;, &lt;threshold = 0&gt;)
Description
Same as Log(Gamma Density(x, alpha)) except that it has a much greater range.
Gamma Log Distribution(x, alpha, &lt;scale = 1&gt;, &lt;threshold = 0&gt;)
Description
Same as Log(Gamma Distribution(x, alpha)) except that it has a much greater range.
172
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
Gamma Quantile(p, &lt;shape, scale, threshold&gt;)
Description
Returns the pth quantile from the gamma distribution with the shape, scale, and
threshold parameters given.
GLog Density(q, mu, sigma, lambda)
Description
Returns the density at q of a generalized logarithmic distribution with location mu, scale
sigma, and shape lambda.
GLog Distribution(q, mu, sigma, lambda)
Description
Returns the probability that a generalized logarithmically distribution random variable is
less than q.
GLog Quantile(p, mu, sigma, lambda)
Description
Returns the quantile for whose value the probability is p that a random value would be
lower.
IGamma()
See “Gamma Distribution(x, &lt;shape, scale, threshold&gt;)” on page 171.
Johnson Sb Density(q, gamma, delta, theta, sigma)
Description
Returns the density at q of a Johnson Sb distribution.
Arguments
q A value that is in the interval theta to theta + sigma.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Scale parameter that must be greater than 0.
Johnson Sb Distribution(q, gamma, delta, theta, sigma)
Description
Returns the probability that a Johnson Sb‐distributed random variable is less than q.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
173
Arguments
q A value that is in the interval theta to theta + sigma.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Scale parameter that must be greater than 0.
Johnson Sb Quantile(p, gamma, delta, theta, sigma)
Description
Returns the quantile whose value for which the probability is p that a random value would
be lower.
Arguments
p The probability of the quantile desired; p must be between 0 and 1.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Scale parameter that must be greater than 0.
Johnson Sl Density(q, gamma, delta, theta, sigma)
Description
Returns the density at q of a Johnson Sl distribution.
Arguments
q A value that is in the interval theta to +infinity.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Parameter that defines if the distribution is skewed positively or negatively. Sigma
must be equal to either +1 (skewed positively) or ‐1 (skewed negatively).
Johnson Sl Distribution(q, gamma, delta, theta, sigma)
Description
Returns the probability that a Johnson Sl‐distributed random variable is less than q.
Arguments
q A value that is in the interval theta to +infinity.
gamma Shape parameter that can be any value.
174
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Parameter that defines if the distribution is skewed positively or negatively. Sigma
must be equal to either +1 (skewed positively) or ‐1 (skewed negatively).
Johnson Sl Quantile(p, gamma, delta, theta, sigma)
Description
Returns the quantile whose value for which the probability is p that a random value would
be lower.
Arguments
p The probability of the quantile desired; p must be between 0 and 1.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Parameter that defines if the distribution is skewed positively or negatively. Sigma
must be equal to either +1 (skewed positively) or ‐1 (skewed negatively).
Johnson Su Density(q, gamma, delta, theta, sigma)
Description
Returns the density at q of a Johnson Su distribution.
Arguments
q A value that is between ‐infinity and +infinity.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Scale parameter that must be greater than 0.
Johnson Su Distribution(q, gamma, delta, theta, sigma)
Description
Returns the probability that a Johnson Su‐distributed random variable is less than q.
Arguments
q A value that is between ‐infinity and +infinity.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
175
sigma Scale parameter that must be greater than 0.
Johnson Su Quantile(p, gamma, delta, theta, sigma)
Description
Returns the quantile whose value for which the probability is p that a random value would
be lower.
Arguments
p The probability of the quantile desired; p must be between 0 and 1.
gamma Shape parameter that can be any value.
delta Shape parameter that must be greater than 0.
theta Location parameter that can be any value.
sigma Scale parameter that must be greater than 0.
LEV Density(x, mu, sigma)
Description
Returns the density at x of the largest extreme value distribution with location mu and scale
sigma.
LEV Distribution(x, mu, sigma)
Description
Returns the probability that the largest extreme value distribution with location mu and
scale sigma is less than x.
LEV Quantile(p, mu, sigma)
Description
Returns the quantile associated with a cumulative probability p of the largest extreme value
distribution with location mu and scale sigma.
Logistic Density(x, mu, sigma)
Description
Returns the density at x of a logistic distribution with location mu and scale sigma.
Logistic Distribution(x, mu, sigma)
Description
Returns the probability that the logistic distribution with location mu and scale sigma is less
than x.
176
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
Logistic Quantile(x, mu, sigma)
Description
Returns the quantile associated with a cumulative probability p of the logistic distribution
with location mu and scale sigma.
Loglogistic Density(x, mu, sigma)
Description
Returns the density at x of a loglogistic distribution with location mu and scale sigma.
Loglogistic Distribution(x, mu, sigma)
Description
Returns the probability that the loglogistic distribution with location mu and scale sigma is
less than x.
Loglogistic Quantile(x, mu, sigma)
Description
Returns the quantile associated with a cumulative probability p of the loglogistic
distribution with location mu and scale sigma.
Lognormal Density(x, mu, sigma)
Description
Returns the density at x of a lognormal distribution with location mu and scale sigma.
Lognormal Distribution(x, mu, sigma)
Description
Returns the probability at x of a lognormal distribution with location mu and scale sigma.
Lognormal Quantile(x, mu, sigma)
Description
Returns the quantile at p of a lognormal distribution with location mu and scale sigma.
Normal Biv Distribution(x, y, r, &lt;mu1&gt;, &lt;s1&gt;, &lt;mu2&gt;, &lt;s2&gt;)
Description
Computes the probability that an observation (X, Y) is less than or equal to (x, y) with
correlation coefficient r where X is individually normally distributed with mean mu1 and
standard deviation s1 and Y is individually normally distributed with mean mu2 and
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
177
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.
Normal Density(x, &lt;mean&gt;, &lt;stddev&gt;)
Description
Returns the value of the density function at quantile x for the normal distribution with mean
and stddev. The default mean is 0; the default stddev is 1.
Normal Distribution(x, &lt;mean&gt;, &lt;stddev&gt;)
Description
Returns the cumulative distribution function at quantile x for the normal distribution with
mean and stddev. The default mean is 0. the default stddev is 1.
Normal Log CDistribution(x)
Description
Returns 1 ‐ log (value) of the distribution function at quantile x for the normal distribution.
Normal Log Density(x)
Description
Returns the log of the value of the density function at quantile x for the normal distribution.
Normal Log Distribution(x)
Description
Returns the log of the value of the distribution function at quantile x for the normal
distribution.
Normal Mixture Density(q, mean, stdev, probability)
Description
Returns the density at q of a normal mixture distribution with group means mean, group
standard deviations stdev, and group probabilities probability. The mean, stdev, and probability
arguments are all vectors of the same size.
Normal Mixture Distribution(q, mean, stdev, probability)
Description
Returns the probability that a normal mixture distributed variable with group means mean,
group standard deviations stdev, and group probabilities probability is less than q. The mean,
stdev, and probability arguments are all vectors of the same size.
178
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
Normal Mixture Quantile(p, mean, stdev, probability)
Description
Returns the quantile, the values for which the probability is p that a random value would
be lower. The mean, stdev, and probability arguments are all vectors of the same size.
Normal Quantile(p, &lt;mean&gt;, &lt;stddev&gt;)
Probit(p, &lt;mean&gt;, &lt;stddev&gt;)
Description
Returns the pth quantile from the normal distribution with mean and stddev. The default
mean is 0. the default stddev is 1.
Probit()
See “Normal Quantile(p, &lt;mean&gt;, &lt;stddev&gt;)” on page 178.
SEV Density(x, mu, sigma)
Description
Returns the density at x of the smallest extreme distribution with location mu and scale
sigma.
SEV Distribution(x, mu, sigma)
Description
Returns the probability that the smallest extreme distribution with location mu and scale
sigma is less than x.
SEV Quantile(p, mu, sigma)
Description
Returns the quantile at p of the smallest extreme distribution with location mu and scale
sigma.
Students t Density()
See “t Density(q, df)” on page 179.
Students t Distribution()
See “t Distribution(q, df, &lt;nonCentrality&gt;)” on page 179.
Chapter 2
JSL Syntax Reference
JSL Functions
Probability Functions
179
Students t Quantile()
See “t Quantile(p, df, &lt;nonCentrality&gt;)” on page 180.
t Density(q, df)
Students t Density(q, df)
Description
Returns the value of the density function at quantile x for the Student’s t distribution with
degrees of freedom df.
t Distribution(q, df, &lt;nonCentrality&gt;)
Students t Distribution(q, df, &lt;nonCentrality&gt;)
Description
Returns the probability that a Student’s t distributed random variable is less than q.
NonCentrality defaults to 0.
t Log CDistribution(x, df, &lt;nc&gt;)
Description
Returns 1 ‐ log (value) of the normal distribution function at quantile x for the t
distribution.
t Log Density(x, df, &lt;nc&gt;)
Description
Returns the log of the value of the density function at quantile x for the t distribution.
t Log Distribution(x, df, &lt;nc&gt;)
Description
Returns the log of the value of the distribution function at quantile x for the t distribution.
T Noncentrality(x, df, prob)
Description
Solves the noncentrality such that
prob=T Distribution (x, df, nc)
180
JSL Functions
Probability Functions
Chapter 2
JSL Syntax Reference
t Quantile(p, df, &lt;nonCentrality&gt;)
Students t Quantile(p, df, &lt;nonCentrality&gt;)
Description
Returns the pth quantile from the Student’s t distribution with degrees of freedom df.
NonCentrality defaults to 0.
Tukey HSD P Value(q, n, dfe)
Description
Returns the p‐value from Tukey’s HSD multiple comparisons test.
Arguments
q The test statistic.
n The number of groups in the study.
dfe The error degrees of freedom, based on the total study sample.
Tukey HSD Quantile(1-alpha, n, dfe)
Description
Returns the quantile needed in Tukey’s HSD multiple comparisons test.
Arguments
1-alpha The confidence level.
n The number of groups in the study.
dfe The error degrees of freedom, based on the total study sample.
Weibull Density(x, shape, &lt;scale, threshold&gt;)
Description
Returns the value of the density function at quantile x for the Weibull distribution with the
parameters given.
Weibull Distribution(x, shape, &lt;scale, threshold&gt;)
Description
Returns the cumulative distribution function at quantile x for the Weibull distribution with
the parameters given.
Weibull Quantile(p, shape, &lt;scale, threshold&gt;)
Description
Returns the pth quantile from the Weibull distribution with the parameters given.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
181
Programming Functions
As Column(name)
As Column(dt, name)
:name
dt:name
Description
This scoping operator forces name to be evaluated as a data table column in the current data
table (or the table given by the optional data table reference argument, dt) rather than as a
global variable.
Arguments
name Variable name.
dt The data table reference
Note
:name refers to a column name in the current data table. You can also specify which data
table to refer to by use dt:name.
As Constant(expr)
Description
Evaluates an expression once to create a value that does not change after it is computed.
Returns
The result of the evaluation.
Argument
expr Any JSL expression.
As Global(name)
::name
Description
This scoping operator forces name to be evaluated as a global variable rather than as a data
table column.
Arguments
name Variable name.
182
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
As List(matrix)
Description
Converts a matrix into a list. Multi‐column matrices are converted to a list of row lists.
Returns
A list.
Argument
matrix Any matrix.
As Name(string)
Description
Evaluates argument as a string and changes it into a name.
Returns
A name.
As Namespace(name)
Description
Accesses the specified namespace. An error is thrown if no such namespace exists.
Returns
The namespace.
Arguments
name Unquoted name of a defined namespace.
As Scoped(namespace, variable)
namespace:variable
Description
Accesses the specified variable within the specified namespace.
Returns
The value of the variable, or an error the scoped variable is not found.
Arguments
namespace The name of a defined namespace.
variable A variable defined within namespace.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
183
Associative Array({key, value}, ...)
Associative Array(keys, values)
Description
Creates an associative array (also known as a dictionary or hash map).
Returns
An associative array object.
Arguments
Either list of key‐value pairs; or a list, matrix, or data table column that contains keys
followed by a list, matrix, or data table column, respectively, that contains the
corresponding values.
Clear Globals(&lt;name&gt;, &lt;name&gt;, ...)
Description
Clears the values for all global symbols. Symbols in any scope other than global are not
affected. If one or more names are specified, only those global symbols are cleared.
Returns
Null.
Arguments
name Optional: any global variable name(s).
See
“Clear Symbols(&lt;name&gt;, &lt;name&gt;, ...)” on page 183
Clear Log()
Description
Empties the log.
Clear Symbols(&lt;name&gt;, &lt;name&gt;, ...)
Description
Clear the values for all symbols in any and all scopes. If one or more names are specified,
only those symbols are cleared.
Returns
Null.
Arguments
name Optional: any global variable name(s).
184
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
See
“Clear Globals(&lt;name&gt;, &lt;name&gt;, ...)” on page 183.
Close Log()
Description
Closes the log.
Delete Globals(&lt;name&gt;, &lt;name&gt;, ...)
Description
Deletes all global symbols. Symbols in any scope other than global are not affected. If one
or more names are specified, only those global symbols are cleared.
Arguments
name Optional: any global variable name(s).
See
See “Delete Symbols(&lt;name&gt;, &lt;name&gt;, ...)” on page 184.
Delete Symbols(&lt;name&gt;, &lt;name&gt;, ...)
Description
Deletes all symbols in any and all scopes. If one or more names are specified, only those
symbols are deleted.
Arguments
name Optional: any global variable name(s).
See
“Delete Globals(&lt;name&gt;, &lt;name&gt;, ...)” on page 184.
Eval(expr)
Description
Evaluates expr, and then evaluates the result of expr (unquoting).
Returns
The result of the evaluation.
Argument
expr Any JSL expression.
Eval Insert(string, &lt;startDel&gt;, &lt;endDel&gt;, &lt; &lt;&lt;Use Locale(1) &gt;)
Description
Allows for multiple substitutions.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
Returns
The result.
Arguments
string A quoted string with embedded expressions.
startDel Optional starting delimiter. The default value is ^.
endDel optional ending delimited. The default value is the starting delimiter.
Use Locale(1) Optional argument that preserves locale‐specific numeric formatting.
Eval Insert Into(string, &lt;startDel&gt;, &lt;endDel&gt;)
Description
Allows for multiple substitutions in place. The same operation as in Eval Insert is
performed, and the result is placed into string.
Returns
The result.
Arguments
string A string variable that contains a string with embedded expressions.
startDel Optional starting delimiter. The default value is ^.
endDel optional ending delimited. The default value is the starting delimiter.
Eval List(list)
Description
Evaluates expressions inside list.
Returns
A list of the evaluated expressions.
Arguments
list A list of valid JSL expressions.
Exit(&lt;NoSave&gt;)
Quit(&lt;NoSave&gt;)
Description
Exits JMP.
Returns
Void.
185
186
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
Arguments
NoSave Optional, named command; exits JMP without prompting to save any open files.
This command is not case‐sensitive, and spaces are optional.
First(expr, &lt;expr&gt;, ...)
Description
Evaluates all expressions provided as arguments.
Returns
Only the result of the first evaluated expression.
Arguments
expr Any valid JSL expression.
Function({arguments}, &lt;{local variables}&gt;, &lt;Return(&lt;expr&gt;)&gt;, script)
Description
Stores the body script with arguments as local variables.
Returns
The function as defined. If the Return() argument is specified, the expression is returned.
When called later, it returns the result of the script given the specified arguments.
Arguments
{arguments} A list of arguments to pass into the function.
{local variables} A list of variables that are local to the function. You can declare local
variables in three ways:
{var1, var2}
{var1=0, var1=&quot;a string&quot;}
{Default Local}
The last option declares that all unscoped variables used in the function are local to the
function.
Return(expr) This optional argument returns an expression from an user defined
function. If a null expression is used, a period, “.”, is returned.
script Any valid JSL script.
Get Environment Variable(&quot;variable&quot;)
Description
Retrieves the value of an operating system environment variable.
Returns
A string that contains the value of the specified environment variable. If the specified
variable is not found, an empty string is returned.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
187
Arguments
&quot;variable&quot; A string that contains the name of an environment variable.
Notes
On Macintosh, environment variable names are case‐sensitive. On Windows, the names are
case‐insensitive.
Get Log(&lt;n&gt;)
Description
Returns a list of lines from the log.
Returns
A list of strings. Each string contains one line from the log.
Argument
n Optional, integer. If no argument is specified, all the lines are returned. If a positive
number is specified, the first n lines are returned. If a negative number is specified, the
last n lines are returned. If n=0, no lines are returned (an empty list). If the log is empty,
an empty list is returned.
Include(&quot;pathname&quot;, &lt;named arguments&gt;)
Description
Opens the script file identified by the quoted string pathname, parses the script in it, and
executes it.
Returns
Whatever the included script returns. If you use the &lt;&lt;Parse Only option, Include returns
the contents of the script.
Named Arguments
&lt;&lt;Parse Only Parses the script but does not execute the script.
&lt;&lt;New Context Causes the included script to be run its own unique namespace.
&lt;&lt;Allow Include File Recursion Lets the included script include itself.
Notes
When the parent and included scripts use the global namespace, include &lt;&lt; Names Default
to Here along with &lt;&lt; New Context.
::x = 5;
Show Symbols(); //x = 5;
Include( myfile.jsl);
Show Symbols();
188
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
Include File List()
Description
Returns a list of files that are included at the point of execution.
Is Log Open()
Description
Returns result if log window is open.
List(a, b, c, ...)
{a, b, c, ...}
Description
Constructs a list from a set of items.
Local({name=value, ...}, script)
Description
Resolves names to local expressions.
Local Here(expression)
Description
Creates a local Here namespace block. Use this function to prevent name collisions when
multiple scripts are executed from the same root namespace (for example, when a script
executes two button scripts that have the same variables). The argument can be any valid
JSL expression.
Lock Globals(name1, name2, ...)
Description
Locks one or more global variables to prevent it or them from being changed.
Lock Symbols(&lt;name&gt;, &lt;name&gt;, ...)
Description
Locks the specified symbols, which prevents them from being modified or cleared. If no
symbols are provided, all global symbols are locked. If no symbols are provided and the
script has the Names Default To Here mode turned on, then all local symbols are locked.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
189
LogCapture(expr)
Description
Evaluates the expr, captures the output that would normally be sent to the log, and instead
returns it.
Returns
A string that contains the log output.
Argument
Any valid JSL expression.
Note
No output appears in the log.
N Items(source)
Description
Determines the number of elements in the source specified.
Returns
For a list, the number of items in the list. For an associative array, the number of keys.
Arguments
source A list or an associative array.
Names Default To Here(Boolean)
Description
Determines where unresolved names are stored, either as a global or local (if Boolean is 0)
or in the Here scope (if Boolean is 1).
Namespace(name)
Description
Returns a reference to the named namespace (name).
Argument
Name A namespace name string or a reference to a namespace.
Namespace Exists(name)
Description
Returns 1 if a namespace with the specified name exists; otherwise, returns 0.
190
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
New Namespace(&lt;&quot;name&quot;&gt;, &lt;{expr, ...}&gt;)
Description
Creates a new namespace with the specified name. If a name is not provided, an
anonymous name is provided.
Returns
A reference to the namespace.
Arguments
name An optional, quoted string that contains the name of the new namespace.
{list of expressions} An optional list of expressions within the namespace.
Open Log()
Description
Opens the log. Include the Boolean argument (1) to make the window active, even if it is
already open.
Parameter({name=value, ...}, model expression)
Description
Defines formula parameters for models for the Nonlinear platform.
Parse(string)
Description
Converts a character string into a JSL expression.
Print(expr, expr, ...)
Description
Prints the values of the specified expressions to the log.
Quit()
See “Exit(&lt;NoSave&gt;)” on page 185.
Recurse(function)
Description
Makes a recursive call of the defining function.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
191
Save Log(pathname)
Description
Writes the contents of the log to the specified file location.
Send(obj, message)
obj &lt;&lt; message
Description
Sends a message to a platform object.
Set Environment Variable( &quot;variable&quot;, &lt;&quot;value&quot;&gt;)
Description
Sets the environment variable to the value specified. If the “value” argument is missing or
is an empty string, then the environment variable is deleted from the JMP process
environment variable table.
Show(expr, expr, ...)
Description
Prints the name and value of each expression to the log.
Show Globals()
Description
Shows the values for all global symbols. Symbols in any scope other than global are not
shown.
See
“Show Symbols()” on page 191.
Show Namespaces()
Description
Shows the contents of all user‐defined namespaces, both named and anonymous.
Show Symbols()
Description
Shows the values for all symbols in any and all scopes.
See
“Show Globals()” on page 191.
192
JSL Functions
Programming Functions
Chapter 2
JSL Syntax Reference
Sort List(list|expr)
Description
Sort the elements or terms of list or expr.
Sort List Into(list|expr)
Description
Sort the elements or terms of list or expr in place.
Throw(&quot;text&quot;)
Description
Returns a Throw. If you include text, throwing stores text in a global exception_msg. If
text begins with “!”, throwing creates an error message about where the exception was
caught.
Try(expr1, expr2)
Description
Evaluates expr1. If the evaluation returns a Throw, execution stops, and nothing is returned.
expr2 is evaluated next to return the result.
Examples
Try( Sqrt( &quot;s&quot; ), &quot;invalid&quot; );
&quot;invalid&quot;
Try( Sqrt( &quot;s&quot; ), exception_msg );
{&quot;Cannot convert argument to a number [or matrix]&quot;(1, 2, &quot;Sqrt&quot;, Sqrt/*###*/
(&quot;s&quot;))}
Note
Expr2 can be a character string or the global exception message (exception_msg) that
contains more information about the error returned.
Type(x)
Description
Returns a string that names the type of object x is. The list of possible types is: Unknown,
List, DisplayBox, Picture, Column, TableVar, Table, Empty, Pattern, Date, Integer, Number,
String, Name, Matrix, RowState, Expression, Associative Array, Blob.
Chapter 2
JSL Syntax Reference
JSL Functions
Programming Functions
193
Unlock Symbols(name1, name2, ...)
Unlock Globals(name1, name2, ...)
Description
Unlocks the specified symbols that were locked with a Lock Symbols() or Lock Globals()
command.
Wait(n)
Description
Pauses n seconds before continuing the script.
Watch(all | name1, ...)
Description
Shows variables (global, local, and variables within namespaces) and their values in a
window. If “all” is provided as the argument, all globals are placed into the window.
Note
New globals are not added to the window list.
Watching associative arrays that have been modified using messages is not supported.
Wild()
Description
Only used with Extract Expr() for expression matching to denote a wildcard position that
matches any expression.
Wild List()
Description
Only used with Extract Expr() for expression matching to denote a series of wildcard
arguments that match any expression.
Write(&quot;text&quot;)
Description
Prints text to the log without surrounding quotation marks.
194
JSL Functions
R Integration Functions
Chapter 2
JSL Syntax Reference
R Integration Functions
R Connect( &lt;named_arguments&gt; )
Description
Returns the current R connection object. If there is no connection to R, it intializes the R
integration interfaces and returns an active R integration interface connection as a
scriptable object.
Returns
R scriptable object.
Arguments
Echo(Boolean) Optional. Sends all source lines to the JMP log. This option is global. The
default value is true.
R Execute( { list of inputs }, { list of outputs }, &quot;rCode&quot;,
&lt;named_arguments&gt; )
Description
Submit the specified R code to the active global R connection given a list of inputs. On
completion, the outputs are returned into the specified list.
Returns
0 if successful; nonzero otherwise.
Arguments
{ list of inputs } A list of JMP variable names to be sent to R as inputs.
{ list of outputs } A list of JMP variable names to contain the outputs returned from
R.
rCode A quoted string that contains the R code to submit.
Expand(Boolean) An optional, Boolean, named argument. Performs an Eval Insert() on
the R code before submitting to R.
Echo(Boolean) An optional, Boolean, named argument. Sends all source lines to the JMP
log. This option is global. The default value is true.
Example
Send the JMP variables x and y to R, execute the R statement z &lt;‐ x * y, and then get the R
variable z and return it to JMP.
x = [1 2 3];
y = [4 5 6];
rc = R Execute( {x, y}, {z}, &quot;z &lt;- x * y&quot; );
Chapter 2
JSL Syntax Reference
JSL Functions
R Integration Functions
195
R Get( variable_name )
Description
Gets the named variable from R to JMP.
Returns
The value of the named variable.
Argument
name Required. The name of an R variable whose value to return to JMP.
Example
Assume that a matrix named qbx and a data frame named df are present in your R
connection.
// Get the R variable qbx and placed it into a JMP variable qbx
qbx = R Get( qbx );
// Get the R variable df and placed it into a JMP data table referenced by df
df = R Get( df );
R Get Graphics( &quot;format&quot; )
Description
Gets the last graphics object written to the R graph display window in the specified format.
Returns
A JMP picture object.
Argument
format Required. Specifies the graphics format to be used. The valid formats are &quot;png&quot;,
ʺbmpʺ, ʺjpegʺ, ʺjpgʺ, ʺtiffʺ, and ʺtifʺ.
R Init( named_arguments )
Description
Initializes the R session.
Returns
0 if the initialization is successful; any nonzero value otherwise.
Argument
Echo(Boolean) Optional. Sends all source lines to the JMP log. This option is global. The
default value is true.
R Is Connected()
Description
Determines whether a connection to R exists.
196
JSL Functions
R Integration Functions
Chapter 2
JSL Syntax Reference
Returns
1 if connected; 0 otherwise.
Arguments
None.
R JMP Name to R Name( name )
Description
Maps the specified JMP variable name to the corresponding R variable name using R
naming rules.
Argument
name The name of a JMP variable to be sent to R.
Returns
A string that contains the R name.
R Send( name, &lt;R Name( name )&gt;)
Description
Sends named variables from JMP to R.
Returns
0 if the send is successful; any nonzero value otherwise.
Arguments
name required. The name of a JMP variable to be sent to R.
R Name(name) Optional. You can give the variable that you send to R a different name. For
example
R Send(Here:x, R Name(&quot;localx&quot;))
For data tables only:
Selected(Boolean) optional, named, Boolean. Send only selected rows from the
referenced data table to R.
Excluded(Boolean) optional, named, Boolean. Send only excluded rows from the
referenced data table to R.
Labeled(Boolean) optional, named, Boolean. Send only labeled rows from the referenced
data table to R.
Hidden(Boolean) optional, named, Boolean. Send only hidden rows from the referenced
data table to R.
Colored(Boolean) optional, named, Boolean. Send only colored rows from the referenced
data table to R.
Markered(Boolean) optional, named, Boolean. Send only markered rows from the
referenced data table to R.
Chapter 2
JSL Syntax Reference
JSL Functions
R Integration Functions
197
Row States(Boolean, &lt;named arguments&gt;) optional, named. Includes a Boolean
argument and optional named arguments. Send row state information from the
referenced data table to R by adding an additional data column named “RowState”.
Multiple row states are created by adding together individual settings. The individual
values are as follows:
‒ Selected = 1
‒ Excluded = 2
‒ Hidden = 4
‒ Labeled = 8
‒ Colored = 16
‒ Markered = 32
The named arguments for the Row States() argument are as follows:
Colors(Boolean) optional, named, Boolean. Sends row colors. Adds additional data
column named “RowStateColor”.
Markers(Boolean) optional, named, Boolean. Sends row markers. Adds additional data
column named “RowStateMarker”.
Examples
Create a matrix, assign it to X, and send the matrix to R:
X = [1 2 3];
rc = R Send( X );
Open a data table, assign a reference to it (dt), and send the data table, along with its
current row states, to R:
dt = Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
rc = R Send( dt, Row States(1) );
R Send File( &quot;pathname&quot;, &lt;R Name(&quot;name&quot;)&gt;)
Description
Sends the specified data file from JMP to R.
Returns
0 if the send is successful; any nonzero value otherwise.
Arguments
pathname required. A quoted string that contains a pathname for a file.
R Name(name) Optional. You can give the data file that you send to R a different name.
R Submit( &quot;rCode&quot;, &lt;named_arguments&gt; )
Description
Submits the specified R code to the active global R connection.
198
JSL Functions
R Integration Functions
Chapter 2
JSL Syntax Reference
Returns
0 if successful; nonzero otherwise.
Arguments
rCode A required, quoted string that contains the R code to submit.
Expand(Boolean) An optional, Boolean, named argument. Performs an Eval Insert() on
the R code before submitting to R.
Echo(Boolean) An optional, Boolean, named argument. Sends all source lines to the JMP
log. This option is global. The default value is true.
Async(Boolean) An optional, Boolean, named argument. If set to true (1), the submit can
be canceled either by pressing the ESCAPE key, or by using this message to an R
connection: rconn&lt;&lt;Control( Interrupt( 1 ) ). False (0) is the default value.
Example
rc = R Submit(&quot;\[
x &lt;- rnorm(5)
print(x)
y &lt;- rnorm(5)
print(y)
z = plot(x, y)
]\&quot; );
R Submit File( &quot;pathname&quot; )
Description
Submits statements to R using a file pointed in the specified pathname.
Returns
0 if successful; nonzero otherwise.
Argument
Pathname A quoted string that contains the pathname to the file that contains the R code to
be executed.
R Term()
Description
Terminates the currently active R integration interface
Returns
1 if an active R connection exists; otherwise 0.
Arguments
None
Chapter 2
JSL Syntax Reference
JSL Functions
Random Functions
199
Random Functions
Col Shuffle()
Description
Shuffles the values randomly each time it’s evaluated.
Returns
The last value placed into the last row.
Argument
none
Example
For Each Row(x=:shuffle = colshuffle());
show(x)
x = 6
In a table with 40 rows, the above script places the values 1‐40 randomly into each row of
the column named shuffle. All numbers appear only once. Each time the script is run, the
numbers are placed in a different random order. If the value placed into the row 40 of
column shuffle is 6, that number is assigned to x, as in the above example.
Random Beta(alpha, beta, &lt;theta&gt;, &lt;sigma&gt;)
Description
Generates a pseudo‐random number from a beta distribution using two shape parameters,
alpha and beta. Optionally generates the lower threshold parameter, theta, and the scale
parameter, sigma. The default values are theta = 0 and sigma = 1.
Random Beta Binomial(n, p, &lt;delta&gt;)
Description
Returns a random number from a beta binomial distribution for n trials with probability p
and correlation delta. The default value for delta is 0.
Random Binomial(n, p)
Description
Returns random numbers from a binomial distribution with n trials and probability p of the
event of interest occurring.
Random Category(probA, resultA, ProbB, resultB, resultElse)
Description
Returns a random category given an alternation of probability and result expressions.
200
JSL Functions
Random Functions
Chapter 2
JSL Syntax Reference
Random Cauchy(&lt;alpha&gt;, &lt;beta&gt;)
Description
Returns a Cauchy distribution with given alpha (location) and beta (scale).
Random ChiSquare(df, &lt;noncentral&gt;)
Description
Returns a Chi‐Square distribution with given df (degrees of freedom). The noncentrality
parameter must be greater than zero, which is the default value.
Random Exp()
Description
Returns a random number distributed exponentially from 0 to infinity. Equivalent to the
negative log of Random Uniform.
Random F(dfn, dfd, &lt;noncentral&gt;)
Description
Returns a random number from an F distribution with a given dfn (degrees of freedom
numerator) and dfd (degrees of freedom denominator). The noncentrality parameter must
be greater than zero, which is the default value.
Random Frechet(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a random number from a Fr&eacute;chet distribution with the location mu and scale sigma.
The default values are mu = 0 and sigma = 1.
Random Gamma(lambda, &lt;scale&gt;)
Description
Gives a gamma distribution for given lambda and optional scale. The default value for
scale is 1.
Random Gamma Poisson(lambda, &lt;sigma&gt;)
Description
Returns a random number from a gamma Poisson distribution with parameters lambda
and sigma. The default value for sigma is 1.
Chapter 2
JSL Syntax Reference
JSL Functions
Random Functions
201
Random Geometric(p)
Description
Returns random numbers from the geometric distribution with probability p that a specific
event occurs at any one trial.
Random GLog(mu, sigma, lambda)
Description
Returns a random number from a generalized logarithmic distribution.
Random Index(n, k)
Description
Returns a k by 1 matrix of random integers between 1 and n with no duplicates.
Random Integer(k, n)
Description
Returns a random integer from 1 to n or from k to n.
Random Johnson Sb(gamma, delta, theta, sigma)
Description
Returns a random number from the Johnson Sb distribution.
Random Johnson Sl(gamma, delta, theta, &lt;sigma&gt;)
Description
Returns a random number from the Johnson Sl distribution. The default value for sigma is
1.
Random Johnson Su(gamma, delta, theta, sigma)
Description
Returns a random number from the Johnson Su distribution.
Random LEV(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a random number from an LEV distribution with the location mu and scale sigma.
The default values are mu = 0 and sigma = 1.
202
JSL Functions
Random Functions
Chapter 2
JSL Syntax Reference
Random Logistic(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a random number from a logistic distribution with the location mu and scale sigma.
The default values are mu = 0 and sigma = 1.
Random Loglogistic(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a random number from a loglogistic distribution with the location mu and scale
sigma. The default values are mu = 0 and sigma = 1.
Random Lognormal(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a Lognormal‐distributed random number with location parameter mu and scale
sigma. The default values are mu = 0 and sigma = 1.
Random Negative Binomial(r, p)
Description
Generates a negative binomial distribution for r successes with probability of success p.
Random Normal(&lt;mu&gt;, &lt;sigma&gt;)
Description
Generates random numbers that approximate a normal distribution with mean mu and
standard deviation sigma. The default values are mu = 0 and sigma = 1.
The normal distribution is bell shaped and symmetrical.
Random Normal Mixture(mean, std_dev, probabilities)
Description
Returns a random number from a normal mixture distribution with the specified
arguments.
Arguments
mean A vector that contains group means.
std_dev A vector that contains the group standard deviations.
probabilities A vector that contains the group probabilities.
Chapter 2
JSL Syntax Reference
JSL Functions
Random Functions
203
Random Poisson(lambda)
Description
Generates a Poisson variate for given lambda.
Random Reset(seed)
Description
Restarts the random number sequences with seed.
Random SEV(&lt;mu&gt;, &lt;sigma&gt;)
Description
Returns a random number from an SEV distribution with the specified location mu and
scale sigma. The default values are mu = 0 and sigma = 1.
Random Shuffle(matrix)
Description
Returns the matrix with the elements shuffled into a random order.
Random t(df, &lt;noncentral&gt;)
Description
Returns a random number from a t distribution with the specified df (degrees of freedom).
The noncentrality argument may be negative or positive. The default value of noncentral
is 0.
Random Triangular(midpoint)
Description
Generates a triangular distribution of numbers between 0 and 1 with the midpoint that you
specify.
Random Uniform(&lt;x&gt;)
Random Uniform(&lt;min&gt;, &lt;max&gt;)
Description
Generates random numbers uniformly between 0 and 1. Random Uniform(x) generates
numbers between 0 and x. Random Uniform (min, max) generates numbers between min
and max. The result is an approximately even distribution.
204
JSL Functions
Row Functions
Chapter 2
JSL Syntax Reference
Random Weibull(beta, &lt;alpha&gt;)
Description
Returns a random number from a Weibull distribution. The default value for alpha is 1.
Resample Freq(&lt;rate, &lt;column&gt;&gt;)
Description
Generates a frequency count for sampling with replacement. If no arguments are specified,
the function generates a 100% resample.
Arguments
rate Optional. Specifies the rate of resampling. The default value is 1.
column Optional. If you specify column, you must also specify rate. The sample size is
calculated by the rate multiplied by the sum of the specified column.
Note
A typical use of this function generates a column with many 1s, some 0s, some 2s, and so
forth, corresponding to which rows were randomly assigned any of n randomly selected
rows.
A typical use of this with an existing frequency column produces a new frequency column
whose values are similar to the old frequency column (have that expected value); however,
the values vary somewhat due to random selection at the rates corresponding to the old
frequency column.
See Also
For an example, see the JMP Scripting Index in the Help menu.
Row Functions
As Table(matrix, &lt;matrix 2, ...&gt;, &lt; &lt;&lt;invisible &gt;, &lt; &lt;&lt;Column Names(list)
&gt;)
Description
Creates a new data tables from the matrix.
Returns
The new data table.
Argument
matrix Any matrix.
&lt;&lt;invisible Creates an invisible data table that hides the table from view. The data table
appears only in the JMP Home Window and the Window menu.
Chapter 2
JSL Syntax Reference
JSL Functions
Row Functions
205
&lt;&lt;Column Names(list) The list specified column names for the data. The argument is a
list of quoted column names.
Col Stored Value(&lt;dt&gt;, col, &lt;row&gt;)
Description
Returns the data values stored in the column and disregards values assigned through
column properties (such as Missing Value Codes).
Arguments
dt Optional reference to a data table. If this value is not supplied, the current data table is
used.
col Name of the column.
row Optional. Row name or number. If this value is not specified, the current row is used.
Example
Suppose that the Missing Value Codes column property is assigned to the x1 column to
treat “999” as a missing value. Another column includes a formula that calculates the mean.
To use the value “999” instead of a missing value to calculate the mean, use Col Stored
Value() in the formula:
Mean( Col Stored Value( :x1 ), :x2, :x3 )
Column(&lt;dt&gt;, &quot;name&quot;, &quot;formatted&quot;)
Column(&lt;dt&gt;, n)
Description
Gets a reference to the data table column.
Arguments
dt Optional reference to a data table. If this is not supplied, the current data table is used.
name Quoted string that is the name of the column.
formatted Quoted string that returns the formatted string of the cell value.
n Column number.
Column Name(n)
Description
Determines the name of the column specified by number.
Returns
The name of the nth column as an expression (not a string).
Argument
n The number of a column.
206
JSL Functions
Row Functions
Chapter 2
JSL Syntax Reference
Count(from, to, step, times)
Description
Used for column formulas. Creates row by row the values beginning with the from value
and ending with the to value. The number of steps specifies the number of values in the
list between and including the from and to values. Each value determined by the first three
arguments of the count function occurs consecutively the number of times that you specify.
When the to value is reached, count starts over at the from value. If the from and to
arguments are data table column names, count takes the values from the first row only.
Values in subsequent rows are ignored.
Returns
The last value.
Arguments
from Number, column reference, or expression. Count starts counting with this value.
to Number, column reference, or expression. Count stops counting with this value.
step Number or expression. Specifies the number of steps to use to count between from
and to, inclusive.
times Number or expression. Specifies the number of times each value is repeated before
the next step.
Examples
For Each Row(:colname[row()]=count(0, 6, 3, 1))
//The rows in the column named colname are filled with the series 0, 3, 6, 0,
... until all rows are filled.
For Each Row(:colname[row()]=count(0, 6, 3, 2))
//The rows in the column named colname are filled with the series 0, 0, 3, 3,
6, 6, 0, ... until all rows are filled.
Note
Count() is dependent on Row(), and is therefore mainly useful in column formulas.
Current Data Table(&lt;dt&gt;)
Description
Without an argument, gets the current (topmost) data table. With an argument, sets the
current data table.
Returns
Reference to the current data table.
Argument
dt Optional name of or reference to a data table.
Chapter 2
JSL Syntax Reference
JSL Functions
Row Functions
207
Data Table(n)
Data Table(&quot;name&quot;)
Description
Gets reference to the nth open data table or the table with the given name in a global
variable.
Returns
Reference to the specified data table.
Argument
n Number of a data table.
name Quoted string, name of a data table.
Dif(col, n)
Description
Calculates the difference of the value of the column col in the current row and the value n
rows previous to the current row.
Returns
The difference.
Arguments
col A column name (for example, :age).
n A number.
Lag(col, n)
Description
Returns for each row the value of the column n rows previous.
N Row(dt); NRow(matrix)
N Rows(dt); NRows(matrix)
Description
Returns the number of rows in the data table given by dt or in the matrix.
N Table()
Description
Returns the number of open data tables.
208
JSL Functions
Row Functions
Chapter 2
JSL Syntax Reference
New Column(&quot;name&quot;, attributes)
Description
Adds a new column named &quot;name&quot; after the last column in dt.
Note
Can also be used as a message: dt&lt;&lt;New Column(&quot;name&quot;, attributes).
New Table(&quot;name&quot;, &lt;&quot;invisible&quot; | &quot;private&quot;&gt;, &lt;actions&gt;)
Description
Creates a new data table with the specified name.
Arguments
name A quoted string that contains the name of the new table.
invisible Optional quoted keyword that hides the table from view. The data table
appears only in the JMP Home Window and the Window menu
private Optional quoted keyword that hides the new table from view and from the
Window List pane.
actions Optional argument that can define the new table.
Row()
Row() = y
Description
Returns or sets the current row number. No argument is expected.
Sequence(from, to, &lt;stepSize&gt;, &lt;repeatTimes&gt;)
Description
Produces an arithmetic sequence of numbers across the rows in a data table. The stepSize
and repeatTimes arguments are optional, and the default value for both is 1.
Subscript(a, b, c)
list[i]
matrix[b, c]
Description
Subscripts for lists extract the ith item from the list, or the bth row and the cth column
from a matrix.
Chapter 2
JSL Syntax Reference
Suppress Formula Eval(Boolean)
Description
Turns off automatic calculation of formulas for all data tables.
Row State Functions
As Row State(i)
Description
Converts i into a row state value.
Returns
A row state from the i given.
Argument
i an integer
Color Of(rowstate)
Description
Returns or sets the color index.
Returns
The color index of rowstate.
Argument
rowstate a row state argument
Example
Set the color of the fifth row to red.
colorof(rowstate(5))=3
Color State(i)
Description
Returns a row state with the color index of i.
Returns
A row state.
Argument
i index for a JMP color
JSL Functions
Row State Functions
209
210
JSL Functions
Row State Functions
Chapter 2
JSL Syntax Reference
Combine States(rowstate, rowstate, ...)
Description
Generates a row state combination from two or more row state arguments.
Returns
A single numeric representation of the combined row states.
Arguments
rowstate Two or more row states.
Excluded(rowstate)
Description
Returns or sets an excluded index.
Returns
The excluded attribute, 0 or 1.
Argument
rowstate One or more row states.
Excluded State(num)
Description
Returns a row state for exclusion from the num given.
Hidden(rowstate)
Description
Returns or sets the hidden index.
Hidden State(num)
Description
Returns a row state for hiding from the num given.
Hue State(num)
Description
Returns a hue state from the num given.
Labeled(rowstate)
Description
Returns or sets the labeled index.
Chapter 2
JSL Syntax Reference
JSL Functions
Row State Functions
211
Labeled State(num)
Description
Returns a labeled state from the num given.
Marker Of(rowstate)
Description
Returns or sets the marker index of a row state.
Marker State(num)
Description
Returns a marker state from the num given.
Row State(&lt;dt,&gt; &lt;n&gt;)
Description
Returns the row state changed from the initial condition of the active row or the nth row.
Arguments
dt Optional positional argument: a reference to a data table. If this argument is not in the
form of an assignment, then it is considered a data table expression.
n The row number.
Example
The following example creates the data table references and then returns the row state of
row 1 in Big Class.jmp:
dt1 = Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
dt2 = Open( &quot;$SAMPLE_DATA/San Francisco Crime.jmp&quot; );
Row State( dt1, 1)
Selected(rowstate)
Description
Returns or sets the selected index.
Selected State(num)
Description
Returns a selected state from the num given.
212
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
Shade State(num)
Description
The Shade State function assigns 5 shade levels to a color or hue.
SAS Integration Functions
As SAS Expr(x)
Description
Converts an expression to a version that is more suitable for SAS data step. Use Expr(...)
for literal expressions. Use NameExpr(name) for expressions stored in a variable. Otherwise,
the expression returns the expression to convert.
Returns
A string.
Current Metadata Connection()
Description
Returns the active SAS metadata server connection, if any, as a scriptable object.
Current SAS Connection()
Description
Gets the active global SAS server connection, if any, as a scriptable object.
Get SAS Version Preference()
Description
Returns the SAS version selected in the SAS Integration page of the Preferences as a string.
JMP6 SAS Compatibility Mode(Boolean)
Description
Setting this to 1 (true) causes SAS operators to operate in a mode compatible with JMP 6
capabilities.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
213
Meta Connect(&lt;&quot;machine&quot;, port&gt;, &lt;&quot;authDomain&quot;&gt;, &lt;&quot;username&quot;&gt;, &lt;&quot;password&quot;&gt;,
&lt;named arguments&gt;)
Meta Connect(&lt;Profile(&quot;profile name&quot;)&gt;, &lt;Password(&quot;password&quot;)&gt;, &lt;named
arguments&gt;)
Meta Connect(&lt;Environment(&quot;environment name&quot;)&gt;, &lt;named arguments&gt;)
Description
Connects to a SAS Metadata Server. If no arguments are specified, an empty connection
window appears. If some arguments are specified, a window partially filled in with the
argument values appears. If all arguments are specified, the connection is made and no
window appears.
Returns
1 if connection is successful, 0 if not.
Arguments
machine Optional: quoted string that contains the DNS name of the machine.
port Required if machine is specified. Quoted string or integer that contains the port on
which the metadata server listens.
authDomain Optional: quoted string that contains the authentication domain for the
credentials supplied. Not necessary unless username and password are included.
username Optional: quoted string that contains the user name for the connection.
password Optional: quoted string that contains the password for the connection.
Named Arguments
All named arguments are optional.
Profile(&quot;profile_name&quot;) A quoted string that contains the name of the metadata server
connection profile from which connection information should be retrieved.
Environment(&quot;environment_name&quot;) A quoted string that contains the name of the WIP
environment from which connection information should be retrieved.
Password(&quot;password&quot;) A quoted string that contains the password for the specified
profile name.
CheckPreferenceOnly(0|1) If specified, Meta Connect returns the status of the I want to
connect to a SAS Metadata Server option in the SAS Integration page of JMP
Preferences. If that box is checked, Meta Connect returns 1; if not, 0.
Repository(&quot;string&quot;) Takes a quoted string that contains the name of the repository to
which to connect.
ProfileLookup(0|1) If machine and port are specified rather than a profile name, and
ProfileLookup is specified, an attempt is made to find a metadata server connection
profile with a machine name and port matching those provided. If one is found, other
214
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
connection information (such as authentication domain, user name, and password) is
obtained from that profile.
Prompt(Always|Never|IfNeeded) Takes one of the keywords Always (always prompt
before attempting to connect), Never (never prompt, just fail), or IfNeeded (the default;
prompt if connection with the given arguments fails).
SASVersion(&quot;&lt;version_number&gt;&quot; &lt;,Strict&gt;) Attempts to change the SAS version
preference to the specified value before making the metadata server connection. If the
SAS version is already locked to a different version than the one specified, the
SASVersion argument will fail. By default, if the SAS version cannot be set, JMP will try
the metadata server connection. However, if you include Strict as the second argument,
the inability to change the SAS version will be treated as an error, and JSL processing
will stop. If you do not include Strict, the SAS version argument is treated as a hint and
will set the version preference if it can. JMP will still try to connect if the version cannot
be set. The order you put these arguments in can make a difference. The attempt to
change the SAS Version is made immediately when that argument is encountered. That
can affect the validity of other arguments, particularly for MetaConnect. Valid values for
SASVersion are “9.1.3”, “9.2”, “9.3”, and “9.4”. Note: Using the SASVersion argument
has the same effect as changing the SAS Server Version on the SAS Integration
Preferences page.
Notes
If no arguments are included and if no profile is saved, the Connect to SAS Metadata Server
window appears.
Meta Create Profile(&quot;profile&quot;, &lt;named arguments&gt;)
Description
Creates a metadata server connection profile and adds it to the current user’s set of saved
metadata server connection profiles.
Returns
1 if profile was successfully created, otherwise 0.
Arguments
profile A quoted string that contains the name of the created profile. If a profile by the
given name already exists, MetaCreateProfile fails unless Replace is specified.
Named Arguments
The following named arguments are all optional.
HostName(&quot;name&quot;) A quoted string that contains the name of the host computer running
the SAS Metadata Server that this profile will connect to.
Port(n) The port number (n) that the SAS Metadata Server is listening for connections on.
AuthenticationDomain(&quot;domain&quot;) | AuthDomain(&quot;domain&quot;) A quoted string that sets
the authentication domain to use for the connection.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
215
Description(&quot;desc&quot;) | Desc(&quot;desc&quot;) A quoted string that sets a description for this
profile.
Password(&quot;password&quot;) A quoted string that contains the password to store in this profile.
Replace(0|1) If name matches a profile that already exists, Replace must be specified for
the existing profile to be replaced by the one provided. The default value is False (0).
Repository(&quot;repository&quot;) A quoted string that contains the name of the repository in
the SAS Metadata Server that this profile will connect to. This option is valid only for
connections to SAS 9.1.3 Metadata Servers.
UserName(&quot;username&quot;) A quoted string that contains the user name that this profile uses
to connect to the SAS Metadata Server.
UseSingleSignOn(0|1) If specified, this profile attempts to use Single Sign‐On (currently
also known as Integrated Windows Authentication) to connect to the SAS Metadata
Server. This option is valid only for connecting to SAS 9.2 or higher Metadata Servers. If
UseSingleSignOn is True(1), UserName and Password cannot be specified. The default
value is False (0).
Meta Delete Profile(&quot;name&quot;)
Description
Deletes the named metadata server connection profile from the current user’s set of saved
metadata server connection profiles
Returns
1 if profile was successfully deleted, otherwise 0.
Argument
name A quoted string that contains the name of the profile to delete.
Meta Disconnect()
Description
Disconnect the current SAS Metadata Server connection, if any.
Returns
Void.
Meta Get Repositories()
Description
Gets a list of the repositories available on the current SAS Metadata Server connection.
Returns
A list of repository names as strings.
216
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
Meta Get Servers()
Description
Get a list of the SAS Servers that are registered in the SAS Metadata Repository to which the
session is currently connected.
Returns
A list of server names as strings.
Meta Get Stored Process(&quot;path&quot;)
Description
Get a stored process object from the currently connected SAS Metadata Repository.
Returns
Stored Process scriptable object.
Arguments
path Quoted string that is the path to the stored process in metadata, starting at the BIP
Tree.
Meta Is Connected()
Description
Determines whether a current connection to a SAS Metadata Server exists.
Returns
1 if a connection exists; 0 otherwise.
Arguments
None.
Meta Set Repository(&quot;repositoryName&quot;)
Description
Set the SAS Metadata Repository to use for metadata searches.
Returns
1 if setting the repository was successful, 0 otherwise.
Arguments
repositoryName Quoted string that contains the name of the repository to make current.
SAS Assign Lib Refs(&quot;libref&quot;, &quot;path&quot;, &lt;&quot;engine&quot;&gt;, &lt;&quot;engine options&quot;&gt;)
Description
Assign a SAS libref on the active global SAS server connection.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
217
Returns
1 if successful, 0 otherwise.
Arguments
libref Quoted string that contains a library reference (8‐character maximum) to assign.
path Quoted string that contains the full path on the SAS server to the library being
assigned.
engine Optional, quoted string that contains the engine for the SAS server to use when
accessing members of this library.
engine options Optional, quoted string that contains the options needed for the engine
being used.
SAS Connect (&lt;&quot;machine_name&quot;&gt;, &lt;&quot;port&quot;&gt;, &lt;named_arguments&gt;)
Description
Connect to a local, remote, or logical SAS server.
Returns
SAS Server scriptable object.
Arguments
machine_name Optional: quoted string that can contain a physical machine name or the
name of a metadata‐defined (logical) server. In the first case, the port must be provided.
In the second case, a port must not be provided. If neither name nor port are included,
and JMP is running on Windows, a connection to SAS on the local machine (via COM) is
attempted, and all named arguments are ignored.
port Optional: quoted string or integer. If name is a physical machine name, this is the port
on that machine to connect to. If name is a metadata‐defined (logical) server, port must
not be included.
Named Arguments
All the named arguments are optional.
UserName(&quot;name&quot;) A quoted string that contains the user name for the connection.
Password(&quot;password&quot;) A quoted string that contains the password for the connection.
ReplaceGlobalConnection(0|1) A Boolean. The default value is True. If True, and a
successful SAS server connection is made, this connection replaces the active SAS
connection that becomes the target of other global SAS JSL function calls. If False, the
global SAS connection is not changed, and the returned SASServer scriptable object
should be used to send messages to this server connection.
ShowDialog(0|1) A Boolean. The default value is False. If True, other arguments (except
ReplaceGlobalConnection) are ignored and the SAS Server Connection window
appears. This provides the JSL programmer a way to open the SAS Connect window.
218
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
Prompt(Always|Never|IfNeeded) A keyword. Always means always prompt before
attempting to connect. Never means never prompt even if the connection attempt fails
(just fail and send an error message to the log), and IfNeeded (the default value) means
prompt if the attempt to connect with the given arguments fails (or is not possible with
the information given).
ConnectLibraries(0|1) A Boolean. Defaults to the SAS Integration Preference setting
governing whether to automatically connect metadata‐defined libraries when
connecting to a SAS server. If true, all metadata‐defined libraries are connected at SAS
server connection time, which can be time‐consuming. If false, metadata‐defined
libraries are not connected. To connect specific libraries later, use the SAS Connect
Libref global function or Connect Libref message to a SAS server object.
SASVersion(&quot;&lt;version_number&gt;&quot; &lt;,Strict&gt;) Attempts to change the SAS version
preference to the specified value before making the metadata server connection. If the
SAS version is already locked to a different version than the one specified, the
SASVersion argument will fail. By default, if the SAS version cannot be set, the metadata
server connection will still be tried. However, if you include Strict as the second
argument, the inability to change the SAS version will be treated as an error and JSL
processing will stop. If you do not include Strict, the SAS version argument is treated
as a hint and will set the version preference if it can, but if it cannot it will still try to
connect. The order you put these arguments in can make a difference. The attempt to
change the SAS Version is made immediately when that argument is encountered.
That can affect the validity of other arguments, particularly for MetaConnect. Valid
values for SASVersion are “9.1.3”, “9.2”, “9.3”, and “9.4”. Note: Using the SASVersion
argument has the same effect as changing the SAS Server Version on the SAS Integration
Preferences page.
SAS Deassign Lib Refs(&quot;libref&quot;)
Description
De‐assign a SAS libref on the active global SAS server connection.
Returns
1 if successful; 0 otherwise.
Arguments
libref Quoted string that contains the library reference to de‐assign.
SAS Disconnect()
Description
Disconnect the active global SAS connection, if any.
Returns
1 if a SAS connection exists and was successfully disconnected, 0 otherwise.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
219
Arguments
None.
SAS Export Data(dt, &quot;library&quot;, &quot;dataset&quot;, &lt;named_arguments&gt;)
Description
Exports a JMP data table to a SAS data set in a library on the active global SAS server
connection.
Returns
1 if the data table was exported successfully; 0 otherwise.
Arguments
dt data table or a reference to a data table.
&quot;library&quot; the library to which to export the data table.
&quot;dataset&quot; the name of the new SAS data set.
Named Arguments
All the named arguments are optional.
Columns(list)|Columns(col1, col2, ...) A list of columns or a comma‐separated list
of columns.
Password(&quot;password&quot;) A string that contains the password to serve as the READ,
WRITE, and ALTER password for the exported SAS data set. If the exported data set is
replacing an existing data set with an ALTER password, this password is used as the
ALTER password for overwriting the data set. If Password is specified, values for
ReadPassword, WritePassword, and AlterPassword are ignored.
ReadPassword(&quot;password&quot;) A string that contains the password to serve as the READ
password for the exported SAS data set.
WritePassword(&quot;password&quot;) A string that contains the password to serve as the WRITE
password for the exported SAS data set.
AlterPassword(&quot;password&quot;) A string that contains the password to serve as the ALTER
password for the exported SAS data set. If the exported data set is replacing an existing
data set with an ALTER password, this password is used as the ALTER password for
overwriting the data set.
PreserveSASColumnNames(0|1) A Boolean. If true and the JMP data table originally came
from SAS, the original SAS column names are used in the exported SAS data set. The
default value is False.
PreserveSASFormats(0|1) A Boolean. If true and the JMP data table originally came from
SAS, the original SAS formats and informats are applied to the columns in the exported
SAS data set. The default value is True.
ReplaceExisting(0|1) A Boolean. If true, an existing SAS data set with the specified
name in the specified library is replaced by the exported SAS data set. If false, a data set
220
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
with the specified name already exists in the specified library; the export is stopped. The
default value is false.
SaveJMPMetadata(0|1) Includes SAS 9.4 Extended Attributed to store JMP metadata
(such as table script and column properties). Default is 0 (disabled).
HonorExcludedRows(0|1) A Boolean. If true, any rows in the JMP data table that are
marked as excluded are not exported. The default value is false.
Note
Information about the export is sent to the log.
SAS Get Data Sets(&quot;libref&quot;)
Description
Returns a list of the data sets defined in a SAS library.
Returns
List of strings.
Arguments
libref Quoted string that contains the SAS libref or friendly library name associated with
the library for which the list of defined SAS data sets is returned.
SAS Get File(&quot;source&quot;, &quot;dest&quot;, &quot;encoding&quot;)
Description
Get a file from the active global SAS server connection. JMP creates a FILENAME statement
(with an encoding, if specified) and uses it to read the file on the SAS server.
Returns
1 if successful, 0 otherwise.
Arguments
source Quoted string that contains the full path of file on the server to be downloaded to
the client machine.
dest Quoted string that contains the full path on the client machine for where to put the
copy of the file downloaded from the server.
encoding Quoted string that contains the encoding used in the file (for example, &quot;utf-8&quot;).
The server must support the specified encoding.
SAS Get File Names(&quot;fileref&quot;)
Description
Get a list of filenames found in the given fileref on the active global SAS server connection.
Returns
List of strings.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
221
Arguments
fileref Quoted string that contains the name of the fileref from which to retrieve
filenames.
SAS Get File Names In Path(&quot;path&quot;)
Description
Get a list of filenames found in the given path on the active global SAS server connection.
Returns
List of strings.
Arguments
path Quoted string that contains the directory path on the server from which to retrieve
filenames.
SAS Get File Refs()
Description
Get a list of the currently defined SAS filerefs on the active global SAS server connection.
Returns
List of two lists. The first list is a list of quoted strings of fileref names. The second is a
corresponding list of quoted strings of physical names.
SAS Get Lib Refs(&lt;named arguments&gt;)
Description
Get a list of the currently defined SAS librefs on the current global SAS server connection.
Returns
List of strings.
Named Arguments
Friendly Names(0|1) Optional, Boolean. If True, then for any libraries that have friendly
names (metadata‐defined libraries), the friendly name is returned rather than the
8‐character libref.
SAS Get Log()
Description
Retrieve the SAS Log from the active global SAS server connection.
Returns
A string.
222
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
SAS Get Output()
Description
Retrieve the listing output from the last submission of SAS code to the current global SAS
server connection.
Returns
A string.
SAS Get Results()
Description
Retrieve the results of the previous SAS Submit as a scriptable object, which allows
significant flexibility in what to do with the results.
Returns
A SAS Results Scriptable object.
SAS Get Var Names(string, &lt;&quot;dataset&quot;&gt;, &lt;password(&quot;password&quot;)&gt;)
Description
Retrieves the variable names contained in the specified data set on the current global SAS
server connection.
Returns
List of strings.
Arguments
string A quoted string that contains one of the following:
‒ The name of the SAS Library containing the SAS data set to be imported. In that case,
the dataset name argument is required.
‒ The full member name of the SAS data set to be imported, in the form
“libname.membername”.
‒ The SAS Folders tree path to a logical SAS data table to be imported. This option
requires a connection to a SAS 9.2 or higher Metadata Server.
dataset Optional: quoted string that contains the name of the data set from which to
retrieve variable names.
password(&quot;password&quot;) Optional, quoted string that contains the read password for the
data set. If this is not provided and the data set has a read password, the user is
prompted to enter it.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
223
SAS Import Data(string, &lt;&quot;dataset&quot;&gt;, &lt;named arguments&gt;)
Description
Import a SAS data set from the active global SAS server connection into a JMP table.
Returns
JMP Data Table object.
Arguments
string A quoted string that contains one of the following:
‒ The name of the SAS Library containing the SAS data set to be imported. In that case,
the &quot;dataset&quot; name argument is required.
‒ The full member name of the SAS data set to be imported, in the form
“libname.membername”.
‒ The SAS Folders tree path to a logical SAS data table to be imported. This option
requires a connection to a SAS 9.2 or higher Metadata Server.
dataset Optional: quoted string that contains the name of the data set.
Named Arguments
All named arguments are optional.
Columns(&quot;list&quot;)|Columns(col1, col2, ...) A quoted string list or multiple strings
that contain the names of columns to include in the import.
ConvertCustomFormats(0|1) The default value is True (1). If True and custom formats
are found in the SAS data set being imported, an attempt is made to convert the SAS
custom formats to JMP value labels for those columns.
Invisible(0|1) The default value is False (0). If true, the JMP data table is hidden from
view. The data table appears only in the JMP Home Window and the Window menu.
Hidden data tables remain in memory until they are explicitly closed, reducing the
amount of memory that is available to JMP. To explicitly close the hidden data table, call
Close(dt), where dt is the data table reference returned by SASImportData.
Where(&quot;filter&quot;) A quoted string that contains the filter to use when importing data, as
in Where(&quot;salary&lt;50000&quot;).
Password(&quot;password&quot;) A quoted string that contains the read password for the data set.
If this is not provided and the data set has a read password, the user is prompted to enter
it.
UseLabelsForVarNames(0|1) If True, the labels from the SAS data set become the column
names in the resulting JMP table. If False, the variable names from the SAS data set
become the column names in the JMP table. The default value is False.
RestoreJMPMetadata(0|1) Includes SAS 9.4 Extended Attributed to store JMP metadata.
Default is 0 (disabled).
224
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
Sample(named arguments) optional, named. Allows a random sample of the SAS data set
to be imported into JMP. If both Where and Sample are specified, the WHERE clause is
used to filter the SAS data set first, and then a random sample of the resulting rows is
taken based on the arguments supplied to Sample. Note that Sample uses PROC
SURVEYSELECT on the SAS server, which is available only if the SAS/STAT package is
licensed and installed on that server. The documentation for PROC SURVEYSELECT
might be helpful in understanding how sampling is performed. By default (if no
arguments are supplied), a 5% simple random sample is taken. Available arguments (all
optional) to Sample are as follows:
‒ Simple | Unrestricted: If Simple is specified, sampling is performed without
replacement. If Unrestricted is specified, sampling is performed with replacement.
These two options are mutually exclusive and only one can be specified.
‒ SampleSize(int) | N(int): Total number of rows for the sample, or number of rows
per strata level for stratified sampling
‒ SampleRate(number) | Rate(number) | Percent(number): Specifies the sampling rate.
For stratified sampling, the rate is applied to each strata level. Note that the supplied
value is assumed to be a percentage, so SampleRate(3.5) means a 3.5% sampling rate.
‒ Strata({col1, col2, ...}) | Strata(col1, col2, ...): Perform stratified random
sampling using the column names supplied as Strata variables.
‒ NMin(int): Minimum number of rows (either overall or per strata level for stratified
sampling) to return. Only applies to rate‐based sampling.
‒ NMax(int): Maximum number of rows (either overall or per strata level for stratified
sampling) to return. Only applies to rate‐based sampling.
‒ Seed(int): Number to use as the seed for sampling. Useful for replicating the same
sample. By default, the seed is a random number based on time of day. See PROC
SURVEYSELECT documentation for more information.
‒ OutputHits(0|1): Boolean; the default value is false. When doing Unrestricted
sampling, if the same row of the input data set is selected more than once, by default
that row still appears only once in the resulting JMP data table, with the NumberHits
column indicating the number of times that the row was selected. Setting OutputHits
to true causes an input row that is selected multiple times to appear multiple times in
the resulting JMP data table.
‒ SelectAll(0|1): Boolean, the default value is true. If SelectAll is true, PROC
SURVEYSELECT selects all stratum rows whenever the stratum sample size exceeds
the total number of rows in the stratum. If SelectAll is false and PROC
SURVEYSELECT finds a case where the stratum sample size exceeds the total number
of rows in a given stratum, an error results and sampling fails. SelectAll only applies
to Simple random sampling.
SQLTableVariable(0|1) If True, an SQL table variable is created in the resulting JMP
table that shows the SQL that was submitted to SAS to obtain the data. If False, the SQL
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
225
table variable is not created. The default value is True. If an SQL table variable is created
and the data set required a read password, the password is masked.
SAS Import Query(&quot;sqlquery&quot;, &lt;named arguments&gt;)
Description
Execute the requested SQL query on the current global SAS server connection, importing
the results into a JMP data table.
Returns
JMP Data Table object.
Arguments
sqlquery Quoted string that contains the SQL query to perform and from which to import
the result.
Named Arguments
All named arguments are optional.
ConvertCustomFormats(0|1) The default value is true. If true and custom formats are
found in the SAS data set being imported, an attempt is made to convert the SAS custom
formats to JMP value labels for those columns.
Invisible(0|1) The default value is false. If true, the JMP data table is hidden from view.
The data table appears only in the JMP Home Window and the Window menu. Hidden
data tables remain in memory until they are explicitly closed, reducing the amount of
memory that is available to JMP. To explicitly close the hidden data table, call Close(dt),
where dt is the data table reference returned by SAS Import Query.
UseLabelsForVarNames(0|1) The default value is true. If True, the labels from the SAS
data set become the column names in the resulting JMP table. If False, the variable
names from the SAS data set become the column names in the JMP table.
RestoreJMPMetadata(0|1) Includes SAS 9.4 Extended Attributes to store JMP metadata.
Default is 0 (disabled).
SQLTableVariable(0|1) The default value is true. If True, an SQL table variable is
created in the resulting JMP table that shows the SQL that was submitted to SAS to
obtain the data. If False, the SQL table variable is not created. If an SQL table variable is
created and the data set required a read password, the password is masked.
SAS Is Connected()
Description
Discovers whether there is an active global SAS server connection.
Returns
1 if an active global SAS connection exists, 0 otherwise.
226
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
SAS Is Local Server Available()
Description
Returns True if a local SAS Server is available; otherwise, returns False.
SAS Load Text File(&quot;path&quot;)
Description
Download the file specified in path from the active global SAS server connection and
retrieve its contents as a string.
Returns
String.
Arguments
&quot;path&quot; Quoted string that contains the full path on the server of the file to download and
retrieve the contents as a string.
SAS Name(&quot;name&quot;)
SAS Name({list of names})
Description
Converts JMP variable names to SAS variable names by changing special characters and
blanks to underscores and various other transformations to produce a valid SAS name.
Returns
A string that contains one or more valid SAS names, separated by spaces.
Argument
&quot;name&quot; A quoted string that represents a JMP variable name; or a list of quoted JMP
variable names.
SAS Open For Var Names(&quot;path&quot;)
Description
Opens a SAS data set only to obtain the names of its variables, returning those names as a
list of strings.
Returns
A list of variable names in the file.
Argument
path A quoted string that is a pathname of a SAS data set.
Chapter 2
JSL Syntax Reference
JSL Functions
SAS Integration Functions
227
SAS Send File(&quot;source&quot;, &quot;dest&quot;, &quot;encoding&quot;)
Description
Send a file from the client machine to the active global SAS server connection. JMP creates a
FILENAME statement (with an encoding, if specified) and uses it to save the file on the SAS
server.
Returns
1 if successful, 0 otherwise.
Arguments
source Quoted string that contains the full path of the file on the client machine to be
uploaded to the server.
dest Quoted string that contains the full path on the server that receives the file uploaded
from the client machine.
encoding Quoted string that contains the encoding used in the file (for example, “utf‐8”).
The server must support the specified encoding.
SAS Submit(&quot;sasCode&quot;, &lt;named arguments&gt;)
Description
Submit some SAS code to the active global SAS server connection.
Returns
1 if successful, 0 otherwise.
Arguments
sasCode Quoted string that contains the SAS code to submit.
Named Arguments
All named arguments are optional.
Async(0|1) A Boolean. If True (1), the submit occurs asynchronously (in the background).
Use the Get Submit Status() message on the SAS Server Scriptable Object to determine
the status of the submit. The default value is False (0).
ConvertCustomFormats(0|1) A Boolean. When SAS data sets generated by submitted
SAS code are imported into JMP after the submit completes (see Open Output Datasets),
the value of ConvertCustomFormats determines whether an attempt is made to convert
any custom formats found on columns in the SAS data to JMP value labels. The default
value is True (1).
DeclareMacros(var1, var2, ...) JSL variable names. Provides a simple way to pass
the values of JSL variables to SAS as macro variables. Each JSL variable specified should
evaluate to a string or numeric value. Fully qualified JSL variables names, only the
variable name is sent to SAS. For example, namespace:variable_name becomes
variable_name in SAS.
228
JSL Functions
SAS Integration Functions
Chapter 2
JSL Syntax Reference
GetSASLog(&lt;Boolean|OnError&gt;, &lt;JMPLog|Window&gt;) A Boolean. If no arguments are
supplied, the SAS Log is retrieved and displayed in the location indicated in SAS
Integration Preferences. The first argument to GetSASLog can be either a Boolean value or
the keyword OnError. If a Boolean value is supplied, true means display the SAS Log,
and false means not to display it. OnError instructs JMP to only show the SAS Log if an
error occurred in the submit. The second argument to GetSASLog tells JMP where to
display the SAS Log. If JMPLog is specified, the SAS Log is appended to the JMP Log. If
Window is specified, the SAS Log is opened in a separate window.
GraphicsDevice(string) or GDevice(string) A string that specifies a value for the
GDEVICE SAS option to be used for graphics generated by the submitted SAS code. The
value must be a valid SAS graphics device. The default value is determined in
Preferences.
Interactive(0|1) JMP includes the QUIT statement in the generated wrapper code.
Interactive PROCs work even if JMP is generating the ODS wrapper. On every SUBMIT,
specify the argument that is part of an interactive sequence. Otherwise, QUIT will be
generated in both the prologue‐generated and epilogue‐generated code.
NoOutputWindow A Boolean. If True, the SAS Output window containing the listing output
from the submission does not appear. The default value is False.
ODS(0|1) If true, additional SAS code is submitted causing ODS results to be generated for
the submitted SAS code. The default value is determined in Preferences.
ODSFormat(string) A quoted string that determines the format of generated ODS results.
Valid values are “HTML”, “RTF”, and “PDF”. The default value is determined in
Preferences.
ODSGraphics(0|1) If true, ODS statistical graphics are generated for the submitted SAS
code. Setting ODSGraphics to true causes ODS to also be set to true. The default value is
determined in Preferences.
ODSStyle(string) A quoted string that specifies the ODS Style to use when generating
ODS results. String must be a valid SAS Style. The default value is determined in
Preferences.
ODSStyleSheet(path) A quoted string that specifies a local CSS style sheet to use when
formatting generated ODS results. Path must be a path to a CSS file valid for the client
machine (the machine running JMP). The default value is determined in Preferences.
OnSubmitComplete(script) A quoted string that specifies a JSL script that should be run
when the submit completes. This is especially useful for asynchronous submits. If script
is the name of a defined JSL function, that function is executed, with the SAS Server
scriptable object passed as the first argument.
OpenODSResults(0|1) If true, ODS results that are generated by the submitted SAS code
(due to ODS being true) are automatically opened after the submit completes. The
default value is True (1).
Chapter 2
JSL Syntax Reference
JSL Functions
SQL Functions
229
OpenOutputDatasets(&lt;All|None|dataset1, dataset2, ...&gt;) JMP detects when
submitted SAS code creates new SAS data sets. OpenOutputDatasets (which can be
abbreviated OutData) determines what, if anything, is done with those data sets with the
SAS Submit completes. If All is specified, all data sets generated by the SAS code are
imported into JMP when the SAS Submit completes. If None is specified, none of the
generated data sets are imported. If there are specific data sets known to be generated by
the submitted SAS code that you want to be imported into JMP when the SAS submit
completes, you can alternative provide their names, and only the requested data sets are
imported. The default value is determined in Preferences.
Title(string) A quoted string that specifies the window title to use for the window that
displays ODS output from the submit.
SAS Submit File(&quot;filename&quot;, &lt;named arguments&gt;)
Description
Submit a SAS code file to the active global SAS server connection.
Returns
1 if successful; 0 otherwise.
Arguments
filename Quoted string that contains the name of file containing SAS code to submit.
Named Arguments
Same as for SAS Submit.
SQL Functions
Note: Database table names that contain the characters $# -+/%()&amp;|;? are not supported.
As SQL Expr(x)
Description
Converts an expression to code that you can use in an SQL Select statement. Use Expr(...)
for literal expressions. Use NameExpr(name) for expressions stored in a variable. Otherwise,
the expression returns the expression to convert.
Returns
A string.
New SQL Query(Connection
(&quot;ODBC:connection_string&quot;)|(&quot;SAS:connection_string&quot;),
230
JSL Functions
SQL Functions
Chapter 2
JSL Syntax Reference
Select(Column(&quot;column&quot;, &quot;t1&quot;)), From(Table(&quot;table&quot;, &lt;Schema(&quot;schema&quot;)&gt;,
&lt;Alias(&quot;t1&quot;)&gt;))
New SQL
Query(Connection(&quot;ODBC:connection_string;&quot;)|(&quot;SAS:connection_string;&quot;),
Custom(&quot;SELECT col1, col2, col3 FROM table;&quot;))
Description
Creates an SQL Query object for the specified connection, columns, data table, or for the
custom SQL query.
Returns
A data table that contains the queried data. The data table includes the SQL query string
and table scripts for modifying and updating the query.
Arguments
Connection The string for an ODBC or SAS connection.
Select The column that you want to select and its alias.
From The table that is queried and the optional schema and column alias.
Custom An SQL statement that selects columns from the specified table.
Run Background(&lt;OnRunComplete(script), &lt;private&gt;&gt;,
&lt;OnRunCanceled(script)&gt;, &lt;OnError(script)&gt;
Description
Runs the SQL query in the background. The running query is not displayed.
Returns
Null (or the data table object, if OnRunComplete is included).
Arguments
OnRunComplete Optional. Specifies a script to run after the query is complete. To get the
resulting data table, include OnRunComplete.
private Optional. Does not open the resulting data table. Specify only with
OnRunComplete.
OnRunCanceled Optional. Specifies a script to run after the user cancels the query.
OnError Optional. Specifies a script to run if an error occurs.
Notes
All queries except for SAS queries run in the background based on the Query Builder
preference “Run the queries in the background when possible”, which is selected by
default. For SAS queries, Run Background() is ignored.
Chapter 2
JSL Syntax Reference
JSL Functions
Statistical Functions
231
Run Foreground(&lt;OnRunComplete(script), &lt;private&gt;&gt;,
&lt;OnRunCanceled(script)&gt;, &lt;OnError(script)&gt;
Description
Runs the SQL query in the foreground.
Returns
A data table that opens when the query is finished.
See “Run Background(&lt;OnRunComplete(script), &lt;private&gt;&gt;, &lt;OnRunCanceled(script)&gt;,
&lt;OnError(script)&gt;” on page 230 for details about the arguments.
Statistical Functions
ARIMA Forecast(column, length, model, estimates, from, to)
Description
Determines the forecasted values for the specified rows of the specified column using the
specified model and estimates.
Returns
A vector of forecasted values for column within the range defined by from and to.
Arguments
column A data table column.
length Number of rows within the column to use.
model Messages for Time Series model options.
estimates A list of named values that matches the messages sent to ARIMA Forecast(). If
you perform an ARIMA Forecast and save the script, the estimates are part of the script.
from, to Define the range of values. Typically, from is between 1 and to, inclusive. If from
is less than or equal to 0, and if from is less than or equal to to, the results include filtered
predictions.
Best Partition(xindices, yindices, &lt;&lt;Ordered, &lt;&lt;Continuous Y,
&lt;&lt;Continuous X)
Description
Experimental function to determine the optimal grouping.
Returns
A list.
Arguments
xindices, yindices Same‐dimension matrices.
232
JSL Functions
Statistical Functions
Chapter 2
JSL Syntax Reference
Col Maximum(name, &lt;By var, ...&gt;)
Col Max(name)
Description
Calculates the maximum value across all rows of the specified column. The result is
internally cached to speed up multiple evaluations.
Returns
The maximum value that appears in the column.
Arguments
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Mean(name, &lt;By var, ...&gt;)
Description
Calculates the mean across all rows of the specified column. The result is internally cached
to speed up multiple evaluations.
Returns
The mean of the column.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Minimum(name, &lt;By var, ...&gt;)
Col Min(name)
Description
Calculates the minimum value across all rows of the specified column. The result is
internally cached to speed up multiple evaluations.
Chapter 2
JSL Syntax Reference
JSL Functions
Statistical Functions
233
Returns
The minimum value that appears in the column.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col N Missing(name, &lt;By var, ...&gt;)
Description
Calculates the number of missing values across all rows of the specified column. The result
is internally cached to speed up multiple evaluations.
Returns
The number of missing values in the column.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Number(name, &lt;By var, ...&gt;)
Description
Calculates the number of nonmissing values across all rows of the specified column. The
result is internally cached to speed up multiple evaluations.
Returns
The number of nonmissing values in the column.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
234
JSL Functions
Statistical Functions
Chapter 2
JSL Syntax Reference
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Quantile(name, p)
Description
Calculates the specified quantile p across all rows of the specified column. The result is
internally cached to speed up multiple evaluations.
Returns
The value of the quantile.
Argument
name a column name.
p a specified quantile p between 0 and 1.
Example
Using Big Class.jmp:
colquantile(:height, .5)
63
63 is the 50th percentile, or the median, of all rows in the height column.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Rank(column)
Description
Ranks each row’s value, from 1 for the lowest value to the number of columns for the
highest value. Ties are broken arbitrarily.
Argument
column The column to be ranked.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Chapter 2
JSL Syntax Reference
JSL Functions
Statistical Functions
235
Col Standardize(name)
Description
Calculates the column mean divided by the standard deviation across all rows of the
specified column.
Returns
The standardized mean.
Argument
name a column name.
Notes
Standardizing centers the variable by its sample standard deviation. Thus, the following
commands are equivalent:
dt&lt;&lt;New Column(&quot;stdht&quot;, Formula(Col Standardize(height)));
dt&lt;&lt;New Column(&quot;stdht2&quot;, Formula((height-Col Mean(height))/Col Std
Dev(height)));
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Col Std Dev(name,&lt;By var, ...&gt;)
Description
Calculates the standard deviation across rows in a column. The result is internally cached
to speed up multiple evaluations.
Returns
The standard deviation.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
236
JSL Functions
Statistical Functions
Chapter 2
JSL Syntax Reference
Col Sum(name,&lt;By var, ...&gt;)
Description
Calculates the sum across rows in a column. Calculating all missing values (Col Sum(.,.))
returns missing. The result is internally cached to speed up multiple evaluations.
Returns
The sum.
Argument
name a column name.
By var Optional: A By variable to compute statistics across groups of rows. Use the By
variable in a column formula or in a For Each Row() function.
Notes
If a data value is assigned by a column property (such as Missing Value Codes), use Col
Stored Value() to base the calculation on the value stored in the column instead. See “Col
Stored Value(&lt;dt&gt;, col, &lt;row&gt;)” on page 205.
Fit Censored(Distribution(&quot;name&quot;), YLow(vector) | Y(Vector),
&lt;YHigh(vector)&gt;, &lt;Weight(vector)&gt;, &lt;X(matrix)&gt;, &lt;Z(matrix)&gt;,
&lt;HoldParm(vector)&gt;)
Description
Fits a distribution using censored data.
Returns
A list that contains parameter estimates, the covariance matrix, the loglikelihood, the AIC,
the BIC, and a convergence message.
Arguments
Distribution(&quot;name&quot;) The quoted name of the distribution to fit.
YLow(vector) | Y(Vector) If you do not have censoring, then use Y and an array of your
data, and do not specify YHigh. If you do have censoring, then specify YLow and YHigh as
the lower and upper censoring values, respectively.
Optional Arguments
YHigh(vector) A vector that contains the upper censoring values. Specify this only if you
have censoring and also specify YLow.
Weight(vector) A vector that contains the weight values.
X(matrix) The regression design matrix for location.
Z(matrix) The regression design matrix for scale.
HoldParm(vector) An array of specified parameters. The parameters should be
nonmissing where they are to be held fixed, and missing where the are to be estimated.
Chapter 2
JSL Syntax Reference
JSL Functions
Statistical Functions
237
This is primarily used to test hypotheses that certain parameters are zero or some other
specific value.
Hier Clust(x)
Description
Returns the clustering history for a hierarchical clustering using Ward’s method (without
standardizing data).
Argument
x A data matrix.
IRT Ability(Q1, &lt;Q2, Q3, ...,&gt; parameter matrix)
Description
Solves for ability in an Item Response Theory model.
KDE(vector, &lt;named arguments&gt;)
Description
Returns a kernel density estimator with automatic bandwidth selection.
Argument
vector A vector.
Named Arguments
All the named arguments are optional.
&lt;&lt;weights Must be a vector of the same length as vector, and can contain any nonnegative
real numbers. Weights represents frequencies, counts, or similar concepts.
&lt;&lt;bandwidth(n) A nonnegative real number. Enter a value of 0 to use the bandwidth
selection argument.
&lt;&lt;bandwidth scale(n) A positive real number.
&lt;&lt;bandwidth selection(n) n must be 0, 1, 2, or 3, corresponding to Sheather and Jones,
Normal Reference, Silverman rule of thumb, or Oversmoother, respectively.
&lt;&lt;kernel(n) n must be 0, 1, 2, 3, or 4, corresponding to Gaussian, Epanechnikov,
Biweight, Triangular, or Rectangular, respectively.
LenthPSE(x)
Description
Returns Lenth’s pseudo‐standard error of the values within a vector.
Argument
x A vector.
238
JSL Functions
Statistical Functions
Chapter 2
JSL Syntax Reference
Max()
See “Maximum(var1, var2, ...)” on page 238.
Maximum(var1, var2, ...)
Max(var1, var2, ...)
Description
Returns the maximum value of the arguments or of the values within a single matrix or list
argument. If multiple arguments are specified, they must be either all numeric values or all
strings.
Mean(var1, var2, ...)
Description
Rowwise mean of the variables specified.
Min
See “Minimum(var1, var2, ...)” on page 238.
Minimum(var1, var2, ...)
Min(var1, var2, ...)
Description
Returns the minimum value of the arguments or of the values within a single matrix or list
argument. If multiple arguments are specified, they must be either all numeric values or all
strings.
N Missing(expression)
Description
Rowwise number of missing values in variables specified.
Number(var1, var2, ...)
Description
Rowwise number of nonmissing values in variables specified.
Product(i=initialValue, limitValue, bodyExpr)
Description
Multiplies the results of bodyExpr over all i until the limitValue and returns a single
product.
Chapter 2
JSL Syntax Reference
JSL Functions
Statistical Functions
239
Quantile(p, arguments)
Description
Quantile of the arguments, where p is a value between 0 and 1, and the arguments are
numbers, lists of numbers, or matrices.
Std Dev(var1, var2, ...)
Description
Rowwise standard deviation of the variables specified.
Sum(var1, var2, ...)
Description
Rowwise sum of the variables specified. Calculating all missing values (Sum(.,.))returns
missing.
Summarize(&lt;dt&gt;, &lt;by&gt;, &lt;count&gt;, &lt;sum&gt;, &lt;mean&gt;, &lt;min&gt;, &lt;max&gt;, &lt;stddev&gt;,
&lt;corr&gt;, &lt;quantile&gt;, &lt;first&gt;)
Description
Gathers summary statistics for a data table and stores them in global variables.
Returns
None.
Arguments
dt Optional positional argument: a reference to a data table. If this argument is not in the
form of an assignment, then it is considered a data table expression.
All other arguments are optional and can be included in any order. Typically, each
argument is assigned to a variable so you can display or manipulate the values further.
name=By(col | list | Eval) Using a BY variable changes the output from single values
for each statistic to a list of values for each group in the BY variable.
Summarize YByX(X(&lt;x columns&gt;, Y (&lt;y columns&gt;), Group(&lt;grouping columns&gt;),
Freq(&lt;freq column&gt;), Weight(&lt;weight column&gt;))
Description
Calculates all Fit Y by X combinations on large‐scale data sets.
Returns
A data table of p‐values and LogWorth values for each Y and X combination. See the
Response Screening chapter in Specialized Models.
240
JSL Functions
Transcendental Functions
Chapter 2
JSL Syntax Reference
Arguments
X(col) The factor columns used in the fit model.
Y(col) The response columns used in the fit model.
Group(gcol) The group of columns used in the fit model.
Freq(col) The frequency (for each row) column used in the fit model.
Weight(col) The importance (or influence) column used in the fit model.
Note
Performs the same function as the Response Screening platform. See Specialized Models for
details.
Summation(init, limitvalue, body)
Description
Summation sums the results of the body statement(s) over all i to return a single value.
Tolerance Limit(1-alpha, p, n)
Description
Constructs a 1-alpha confidence interval to contain proportion p of the means with sample
size n.
Transcendental Functions
Arrhenius(n)
Description
Converts the temperature n to the value of explanatory variable in Arrhenius model.
Returns
11605/(n+273.15)
Argument
n Temperature in Celsius.
Notes
This is frequently used as a transformation.
Arrhenius Inv(n)
Description
The inverse of the Arrhenius function. Converts the value n to the temperature in Celsius.
Chapter 2
JSL Syntax Reference
JSL Functions
Transcendental Functions
Returns
11605/(n‐273.15)
Argument
n The value of the converted explanatory variable in Arrhenius model.
Notes
This is frequently used as a transformation.
Beta(a, b)
Description

 a   b ---------------------a + b
Returns
Returns the beta function.
Arguments
a, b numbers
Digamma(n)
Description
The derivative of the log of the gamma function (LGamma).
Returns
The digamma function evaluated at n.
Argument
n A number
Exp(a)
Description
Raises e to the power a.
Returns
ea.
Argument
a A number
Equivalent Expression
e()^a
241
242
JSL Functions
Transcendental Functions
Chapter 2
JSL Syntax Reference
Factorial(n)
Description
Multiplies all numbers 1 through n, inclusive
Returns
The product.
Arguments
n Any integer
Notes
One and only one argument must be specified.
FFT(list, &lt;named arguments&gt;)
Description
Conducts a Fast Fourier Transformation (FFT) on a list of matrices.
Returns
The function takes one matrix, or a list of matrices for complex numbers. The returned
value is in the same structure as the input argument, a list of either one or two matrices.
Argument
List A list of one or two matrices. If one is provided, it is considered to be the real part. If
two are provided, the first is the real part and the second is the imaginary part. Both
matrices must have the same dimensions, and both must have more than one row.
Named Arguments
All named arguments are optional.
&lt;&lt;inverse(Boolean) If true (1), an inverse FFT is conducted.
&lt;&lt;multivariate(Boolean) If true (1), a multivariate FFT is conducted. If false(0), a spatial
FFT is conducted.
&lt;&lt;scale(number) Multiplies the return values by the specified number.
Fit Transform To Normal(Distribution(&quot;name&quot;), Y(vector), &lt;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.
Returns
A list that contains parameter estimates, the covariance matrix, the log‐likelihood AICc, a
convergence message, and the transformed values.
Chapter 2
JSL Syntax Reference
JSL Functions
Transcendental Functions
243
Gamma(t, &lt;limit&gt;)
Description
The gamma function of x, or for each row if x is a column:
t =
 t – 1 –x
0 x
e
dx
Returns
The gamma.
Note
Gamma(t, limit) is the same integral as Gamma(t) but with the limit of integration that is
defined instead of infinity.
Arguments
t a number or a column
limit optional limit. The default is infinity.
LGamma(t)
Description
Returns the log gamma function for t, which is the natural log of gamma.
Ln()
See “Log(n, &lt;base&gt;)” on page 243.
LnZ(x)
Description
Returns the natural logarithm of x, except when x=0. In that case, 0 is returned. This
function is intended for internal use by derivatives.
Log(n, &lt;base&gt;)
Ln(n)
Description
Returns the natural logarithm (base e logarithm) of n. An optional second argument lets
you specify a different base. For example, Log(n,3) for the base 3 logarithm of n. The Log
argument can be any numeric expression. The expression Log(e()) evaluates as 1, and
Log(32,2) is 5.
244
JSL Functions
Transcendental Functions
Chapter 2
JSL Syntax Reference
Log10(n)
Description
Returns the common (base 10) logarithm of n.
Log1P(n)
Description
Same as Log(1 + x), except that it is more accurate when x is very small.
Logit(p)
Description
Returns log(p/(1-p)).
N Choose K(n, k)
Description
This function returns the number of n things taken k at a time (“n choose k”) and is
computed in the standard way using factorials, as n!   k!  n – k !  . For example,
NChooseK(5,2) evaluates as 10.
Note
This is implemented internally in JMP using lGamma functions. The result is not always an
integer.
Power(a, &lt;b&gt;)
a^b
Description
Raises a to the power of b.
Returns
The product of a multiplied by itself b times.
Arguments
a Can be a variable, number, or matrix.
b Optional. Can be a variable or a number.
Notes
For Power(), the second argument (b) is optional, and the default value is 2. Power(a)
returns a2.
Chapter 2
JSL Syntax Reference
JSL Functions
Transcendental Functions
Root(n, &lt;r&gt;)
Description
Returns the rth root of n, where r defaults to 2 for square root.
SbInv(z, gamma, delta, theta, sigma)
Description
Johnson Sb inverse transformation. If argument is normal, the result is Johnson Sb.
SbTrans(x, gamma, delta, theta, sigma)
Description
Johnson Sb transformation from a doubly bound variable to a standard normal (0, 1)
distribution.
Scheffe Cubic(x1, x2)
Description
Returns x1*x2*(x1-x2). This function supports notation for cubic mixture models.
SlInv(z, gamma, delta, theta, sigma)
Description
Johnson Sl inverse transformation. If argument is normal, the result is Johnson Sl.
SlTrans(x, gamma, delta, theta, sigma)
Description
Johnson Sl transformation from a doubly bound variable to a standard normal (0, 1)
distribution.
Sqrt(n)
Description
Returns the square root of n.
Squash(expr)
Description
An efficient computation of the function 1/ [1 + exp(expr)].
245
246
JSL Functions
Trigonometric Functions
Chapter 2
JSL Syntax Reference
Squish(expr)
Description
–
Equivalent to Squash(-expr), or 1   1 + e expr  .
SuInv(z, gamma, delta, theta, sigma)
Description
Johnson Su inverse transformation. If argument is normal, the result is Johnson Su.
SuTrans(x, gamma, delta, theta, sigma)
Description
Johnson Su transformation from a doubly bound variable to a standard normal (0, 1)
distribution.
Trigamma()
Description
Returns the trigamma function evaluated at n. The trigamma function is the derivative of
the digamma function.
Trigonometric Functions
JMP’s trigonometric functions expect all angle arguments in radians.
ArcCosH(x)
Description
Inverse hyperbolic cosine.
Returns
The inverse hyperbolic cosine of x.
Argument
x Any number, numeric variable, or numeric expression.
ArcCosine(x)
ArCos(x)
Description
Inverse cosine.
Chapter 2
JSL Syntax Reference
Returns
The inverse cosine of x, an angle in radians.
Argument
x Any number, numeric variable, or numeric expression.
ArcSine(x)
ArSin(x)
Description
Inverse sine.
Returns
The inverse sine of x, an angle in radians.
Argument
x Any number, numeric variable, or numeric expression.
ArcSinH(x)
Description
Inverse hyperbolic sine.
Returns
The inverse hyperbolic sine of x.
Argument
x Any number, numeric variable, or numeric expression.
ArcTangent(x)
ArcTan(x)
ATan(x)
Description
Inverse tangent.
Returns
The inverse tangent of x, an angle in radians.
Argument
x Any number, numeric variable, or numeric expression.
ArcTanH(x)
Description
Inverse hyperbolic tangent.
JSL Functions
Trigonometric Functions
247
248
JSL Functions
Trigonometric Functions
Chapter 2
JSL Syntax Reference
Returns
The inverse hyperbolic tangent of x.
Argument
x Any number, numeric variable, or numeric expression.
CosH(x)
Description
Hyperbolic cosine.
Returns
The hyperbolic cosine of x.
Argument
x Any number, numeric variable, or numeric expression.
Cosine(x)
Cos(x)
Description
Cosine.
Returns
The cosine of x.
Argument
x Any number, numeric variable, or numeric expression. The angle in radians.
Sine(expr)
Sin(expr)
Description
Returns the sine.
SinH(expr)
Description
Returns the hyperbolic sine.
Tangent(expr)
Tan(expr)
Description
Returns the tangent of an argument given in radians.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
TanH(expr)
Description
Returns the hyperbolic tangent of its argument.
Utility Functions
Add(a, b, ...)
a+b+...
Description
Adds the values of the listed arguments. No arguments are changed.
Returns
The sum.
Arguments
For Add(), a comma‐separated list of variables, numbers, or matrices.
For a+b, any number of variables, numbers, or matrices.
Notes
Any number of arguments is permitted. If no argument is specified, Add() returns 0.
See Also
The Data Structures chapter in the Scripting Guide.
Batch Interactive(Boolean)
Description
Sets the run‐time environment for JSL to either batch mode or interactive mode.
Returns
The previous setting.
Example
Batch Interactive(1);
&lt;code&gt;
Batch Interactive(0);
// Set Batch mode one
// Revert to previous mode
Note
This function can be used in journal scripts, to ensure that messages are sent to the log
rather than to interactive message windows.
249
250
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Beep()
Description
Produces an alert sound.
Returns
Null.
Blob MD5(blob)
Description
Converts the blob argument into a 16‐byte blob.
Note
The 16‐byte blob is the MD5 checksum, or the hash, of the source blob.
Blob Peek(blob, offset, length)
Description
Creates a new blob from a subrange of bytes of the blob argument.
Returns
A blob object.
Arguments
blob a binary large object.
offset An integer that specifies how many bytes into the blob to begin construction. The
first byte is at offset 0, the second byte at offset 1.
length An integer that specifies how many bytes to copy into the new blob, starting at the
offset.
Build Information()
Description
Returns the build date and time, whether it’s a release or debug build, and the product
name in a comma‐delimited string.
Caption({h, v}, &quot;text&quot;, &lt;Delayed(seconds)&gt;, &lt;Font(font)&gt;, &lt;Font
Size(size)&gt;, &lt;Text Color(&quot;color&quot;)&gt;, &lt;Back Color(&quot;color&quot;)&gt;, &lt;Spoken(Boolean)
Description
Displays a caption window at the location described by {h, v} that displays text. The
caption can be delayed before being displayed by seconds, or can be spoken. You can also
specify the font type, size, and color and background color.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
251
Returns
Null.
Arguments
{h, v} a list with two values. h is the horizontal displacement from the top left corner of
the monitor in pixels. v is the vertical displacement from the top left corner in pixels.
text A quoted string or a reference to a string that is to be displayed in the caption.
Delayed(seconds) seconds is optional delay before displaying the caption. Setting this
option causes this caption and all subsequent captions to be delayed by the specified
number of seconds.
Font(font) Specify the font type.
Font Size(size) Specify the font size.
Text Color(&quot;color&quot;) Specify the color of text.
Back Color(&quot;color&quot;) Specify the background color.
Spoken(Boolean) Causes text to be spoken as well as displayed. The current setting (on
or off) remains in effect until switched by another Caption statement that includes a
Spoken setting.
Datafeed()
See “Open Datafeed()” on page 260.
Debug Break()
When the JSL Debugger is open, this function stops a JSL script from executing at that point in
the script. This function is useful for tracking in the debugger under user‐specified conditions.
If the JSL Debugger is not running, this function does not execute.
Decode64 Double(&quot;string&quot;)
Description
Creates a floating point number from a base 64 encoded string.
Returns
A floating point number.
Arguments
string a base 64 encoded string.
252
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Divide(a, b)
Divide(x)
a/b
Description
Divides a by b. If only one argument is given (divide(x)), divides 1 by x.
Returns
The quotient of a/b; or the reciprocal of x (1/x) if only one argument is provided.
Arguments
a, b, x Can be a variable, number, or matrix.
Notes
If both arguments are matrices, it does matrix division.
See Also
The Data Structures chapter in the Scripting Guide.
Empty()
Description
Does nothing. Used in the formula editor for making empty boxes.
Returns
Missing.
Arguments
None.
Encode64 Double(n)
Description
Creates a base 64 encoded string from a floating point number.
Returns
A base 64 encoded string.
Arguments
n a floating point number.
Faure Quasi Random Sequence(nDim, nRow)
Description
Generates a sequence of spacefilling quasi random numbers using the Faure sequence.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
253
Get Addin(&quot;id&quot;)
Description
Retrieves a registered add‐in by id.
Returns
A scriptable object for the add‐in. Returns empty if no add‐in with the specified ID was
found.
Argument
&quot;id&quot; The ID of an installed add‐in.
Get Addins()
Returns
A list of all registered add‐ins.
Get Addr Info(&quot;address&quot;, &lt;port&gt;)
Description
Converts a name to its numeric address.
Returns
A list of strings. The first element is the command (Get Addr Info). The second is the
results (for example, “ok” if the command was successful). The third is a list of strings of
information. Included in that information is the address that corresponds to the name that
was supplied.
Arguments
address A quoted string that specifies the name (for example, &quot;www.sas.com&quot;).
port The port of the address.
Get Clipboard()
Description
Returns text from the computer’s clipboard. If the content is not text, the result is null.
Get Name Info(&quot;address&quot;, &lt;port&gt;)
Description
Converts a numeric address to its name.
Returns
A list of strings. The first element is the command (GetNameInfo). The second is the results
(for example, “ok” if the command was successful). The third is a list of strings of
254
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
information. Included in that information is the port name that corresponds to the address
that was supplied.
Arguments
address A quoted string that specifies the numeric address (for example,
&quot;149.173.5.120&quot;).
port The port of the address.
Get Platform Preferences(&lt;platform &lt;(option, ...)&gt; ... &gt;)
Get Platform Preference(&lt;platform &lt;(option, ...)&gt; ... &gt;)
Description
Returns the preferences for the specified platforms.
Returns
A list of platform preferences.
Argument
platform Optional. Specifies the platform name. If not specified, all platform preferences
are returned. You can specify one or more preferences for a platform.
option Optional. Specifies the preference value. If not specified, all platform preference
values are returned.
Notes
Table 2.3 describes the syntax for getting platform preferences.
Table 2.3 Get Platform Preferences() Syntax
Syntax
Description
Get Platform Preferences( )
Returns the current option
values for all platform
preferences.
Get Platform Preferences( Platform )
Returns the current option
values for the specified
platform preferences.
Get Platform Preferences( Platform( Option ) )
Returns the current option
values for the specified
platform.
Get Platform Preferences( &lt;&lt;Changed )
Returns the current option
values that have changed for
all platforms.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
255
Table 2.3 Get Platform Preferences() Syntax (Continued)
Syntax
Description
Get Platform Preferences( Platform( &lt;&lt;Changed ) )
Returns the current option
values that have changed for
all platform preferences.
Get Platform Preferences( Platform( Option (
&lt;&lt;Changed ) ) )
Returns the current option
values that have changed for
the specified platform.
Examples
Suppose that the user modified several platform preferences through the JMP Platforms
window or a script.
Platform Preferences(
Distribution( Set Bin Width( 2 ), Horizontal Layout( 1 ) ),
Model Dialog( Keep Dialog Open( 1 ) ),
Graph Builder( Legend Position( &quot;Bottom&quot; ) )
);
To return all of the modified platform preferences, use Get Platform Preferences(
&lt;&lt;Changed ):
Get Platform Preferences( &lt;&lt;Changed );
Platform Preferences(
Distribution( Horizontal Layout( 1 ), Set Bin Width( 2, &lt;&lt;On ) ),
Graph Builder( Legend Position( &quot;Bottom&quot;, &lt;&lt;On ) ),
Model Dialog( Keep dialog open( 1 ) )
);
Get Preferences(&lt;preference_name&gt;)
Get Preference(&lt;preference_name&gt;)
Description
Returns the settings for the specified preferences.
Returns
A list of preference settings.
Argument
preference_name Optional. If no preference is specified, all preferences are returned.
Otherwise, the settings for the specified preference are returned.
Notes
The preferences for the following areas are not accessible in JSL: Text Data Files, Windows
Specific, Mac OS Settings, Fonts, Communications, Script Editor, and JMP Updates. For
256
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
details about getting platform preferences, see “Get Platform Preferences(&lt;platform
&lt;(option, ...)&gt; ... &gt;)” on page 254.
Get Project(&lt;&quot;name&quot;&gt;)
Description
Retrieves either the first project listed in the Project window or the project named.
Returns
The project.
Argument
name An optional project name as a quoted string.
Get Project List()
Description
Returns a list of all open projects.
Returns
A list quoted strings that each contains the name of a project. If no projects are open, the list
is empty.
Glue(expr1, expr2, ...)
expr1; expr2
Description
Evaluates each argument in turn.
Returns
The result of the last argument evaluated.
Arguments
One or more valid JSL expressions.
Note
A semicolon placed between expressions is the more commonly used form for Glue().
Host Is(argument)
Description
Determines whether the host environment is the specified OS.
Returns
True (1) if the current host environment matches the argument, false (0) otherwise.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
257
Argument
Argument Windows or Mac tests for the specified operating system. Bits32 or Bits64 tests
for the specified 32‐bit or 64‐bit machine.
Note
Only one argument can be tested at a time. Invalid arguments return false (0).
Is Alt Key()
Description
Returns 1 if the Alt key is being pressed, or 0 otherwise.
Note
On a Macintosh, Is Alt Key() tests for the Option key.
Is Command Key()
Description
Returns 1 if the Command key is being pressed, or 0 otherwise.
Is Context Key()
Description
Returns 1 if the Context key is being pressed, or 0 otherwise.
Is Control Key()
Description
Returns 1 if the Control key is being pressed, or 0 otherwise.
Note
On a Macintosh, Is Control Key() tests for the Command key.
Is Option Key()
Description
Returns 1 if the Option key is being pressed, or 0 otherwise.
Is Shift Key()
Description
Returns 1 if the Shift key is being pressed, or 0 otherwise.
258
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
JMP Product Name()
Description
Returns either &quot;Standard&quot;, &quot;Pro&quot;, or &quot;Student&quot;, depending on which version of JMP is
licensed.
JMP Version()
Description
Returns the version number of JMP that you are running.
Returns
release.revision&lt;.fix&gt;
Arguments
none
Load DLL(&quot;path&quot; &lt;,AutoDeclare(Boolean | Quiet | Verbose)&gt;)
Load DLL(&quot;path&quot; &lt;, Quiet | Verbose&gt;)
Description
Loads the DLL in the specified path.
Arguments
path A pathname that specifies where to load the DLL.
AutoDeclare(Boolean | Quiet | Verbose) Optional argument. AutoDeclare(1) and
AutoDeclare(Verbose) write verbose messages to the log. AutoDeclare(Quiet) turns
off log window messages. If you omit this option, verbose messages are written to the
log.
Quiet | Verbose Optional argument. When you use Declare Function(), this option
turns off log window messaging (Quiet) or turns on log window messaging (Verbose).
See Also
Once a DLL is loaded, you send the DLL object messages to interact with it. See “Dynamic
Link Libraries (DLLs)” on page 332 in the “JSL Messages” chapter for details about these
messages. The Scripting Guide also includes examples.
Mail(&quot;address&quot;, &quot;subject&quot;, &quot;message&quot;, &lt;&quot;attachment filepath&quot; | {&quot;attachment
1 filepath&quot;, &quot;attachment 2 filepath&quot;, ...}&gt;)
Description
(Windows) Sends e‐mail (using MAPI) to the address with the specified subject and
message texts. Sends one or more attachments specified by the optional attachment
argument. The attachment argument can evaluate to a string or list of strings.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
259
(Macintosh) Creates an e‐mail in the user’s Mail application. The user must click Send in
the e‐mail. On Mountain Lion, you must enter the e‐mail address and subject in the e‐mail
due to operating system limitations. Click the Send message button to send the e‐mail.
Examples
To send an email with multiple attachments:
Mail(
&quot;[email protected]&quot;,
&quot;New data and script&quot;,
&quot;Today’s updated data table and script are attached.&quot;,
{&quot;$DOCUMENTS/wd.jsl&quot;, &quot;$DOCUMENTS/survey.jmp&quot;}
);
or:
list = {&quot;$DOCUMENTS/wd.jsl&quot;, &quot;$DOCUMENTS/survey.jmp&quot;};
Mail(
&quot;[email protected]&quot;,
&quot;New data and script&quot;,
&quot;Today’s updated data table and script are attached.&quot;,
list
);
Notes
On Macintosh, Mail() works on Mountain Lion and Mavericks.
On Windows, the bitness of JMP and the e‐mail client must match. For example, Mail()
does not work in JMP 32‐bit with Microsoft Outlook 64‐bit.
Main Menu(string, &lt;string&gt;)
Description
Execute the command found on JMP’s menu named by the quoted string. The optional
second quoted string specifies the name of the window to send the command to.
Minus(a)
-a
Description
Reverses the sign of a.
Returns
‐a if a is positive (a=3; -a=-3; Minus(a)=-3).
a if a is negative (a=-3; -a=3; Minus(a)=3).
0 if a is 0 (a=0; -a=0; Minus(a)=0).
Missing if a is missing.
260
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Argument
a Can be variable or a number. A variable must contain a number or a matrix.
Multiply(a, b, ...)
a*b*...
Description
Multiplies all values. No arguments are changed.
Returns
The product.
Arguments
Any number of variables, numbers, or matrices.
Notes
Any number of arguments is permitted. If no argument is specified, Multiply() returns 1.
See Also
The Data Structures chapter in the Scripting Guide.
New Project(&quot;name&quot;, &lt;invisible&gt;)
Description
Creates a new project with the specified name.
Returns
The project.
Argument
name A quoted string that contains the name of the new project.
invisible Optional unquoted keyword that creates an invisible project.
Open Datafeed()
Datafeed()
Description
Creates a Datafeed object and window.
Returns
A reference to the Datafeed object.
Arguments
No arguments are required. You usually set up the basic operation of the data feed
within the Open Datafeed() command, however.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
261
Open Project(&quot;pathname&quot;, &lt;&quot;invisible&quot;&gt;)
Description
Opens the project identified by the quoted string ʺpathname&quot;.
Returns
The project.
Arguments
pathname A quoted pathname that points to a project file.
invisible Optional quoted keyword that creates an invisible project.
Parse XML(string, On Element(&quot;tagname&quot;, Start Tag(expr), End Tag(expr)))
Description
Parses an XML expression using the On Element expressions for specified XML tags.
Platform Preferences(platform(option(value)), ...)
Platform Preference(platform(option(value)), ...)
Set Platform Preferences(platform(option(value)), ...)
Set Platform Preference(platform(option(value)), ...)
Description
Sets and resets values for platform options and turns the options on and off.
Arguments
platform Specifies the platform of the preference.
option Specifies the preference name.
value Specifies the preference value.
Notes
Table 2.4 describes the syntax for setting platform preferences.
Table 2.4 Platform Preferences() Syntax
Syntax
Description
Platform Preferences( &lt;&lt;Default )
Platform Preferences( &lt;&lt;Factory Default )
Platform Preferences( Default )
Resets all platform
preferences to their default
values.
Platform Preferences( Platform( &lt;&lt;Default ) )
Platform Preferences( Platform( &lt;&lt;Factory Default ) )
Platform Preferences( Platform( Default ) )
Resets the specified
platform preferences to their
default values.
262
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Table 2.4 Platform Preferences() Syntax (Continued)
Syntax
Description
Platform Preferences( Platform( option ( &lt;&lt;Default ) ) )
Platform Preferences( Platform( option ( &lt;&lt;Factory
Default ) ) )
Resets the specified
platform option to its
default value.
Platform Preferences( Platform( option( value ) ) )
Sets the value of the
specified platform option.
Turned on by default.
Platform Preferences( Platform( option ) )
Resets the specified
platform option back to its
default value.
Platform Preferences( Platform( option( &lt;&lt;On ) ) )
Turns on the specified
platform option.
Platform Preferences( Platform( option( &lt;&lt;Off ) ) )
Turns off the specified
platform option.
Platform Preferences( Platform( option( value, &lt;&lt;On ) )
)
Sets the value of the
specified platform option
and turns it on.
Platform Preferences( Platform( option( value, &lt;&lt;Off )
) )
Sets the value of the
specified platform option
and turns it off.
Example
The following expression selects (or turns on) Set Bin Width in the Distribution platform
preferences and sets the value to 2:
Platform Preferences( Distribution( Set Bin Width( 2 ) ) );
The following expression changes the Set Bin Width value and turns the option off:
Platform Preferences( Distribution( Set Bin Width( 2, &lt;&lt;Off ) ) );
The following expression resets the default Set Bin Width value and deselects the
preference:
Platform Preferences( Distribution( Set Bin Width( &lt;&lt;Default ) ) );
Polytope Uniform Random(samples, A, b, L, U, neq, nle, nge, &lt;nwarm=200&gt;,
&lt;nstride=25&gt;)
Description
Generates random uniform points over a convex polytope.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
263
Arguments
Samples The number of random points to be generated.
A The constraint coefficient matrix.
B The right hand side values of constraints.
L, U The lower and upper bounds for the variables.
neq The number of equality constraints.
nle The number of less than or equal inequalities.
nge The number of greater than or equal inequalities.
nwarm Optional: The number of warm‐up repetitions before points are written to the
output matrix.
nstride Optional: The number of repetitions between each point that is written to the
output matrix.
Note
The constraints must be listed as equalities first, less than or equal inequalities next, and
greater than or equal inequalities last.
Preferences(pref1(value1), ...)
Preference(pref1(value1), ...)
Pref(pref1(value1), ...)
Prefs(pref1(value1), ...)
Set Preferences(pref1(value1), ...)
Set Preference(pref1(value1), ...)
Description
Sets preferences for JMP.
Arguments
Analysis Destination(window) Specifies where to route new analyses.
Annotation Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for annotations in reports.
Axis Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for axis labels.
Axis Title Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for axis titles.
Background Color( {R, G, B} | &lt;color&gt; ) Sets the background color for windows.
Calculator Boxing(Boolean) Turns on boxing to show hierarchy of expressions.
Data Table Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for data tables.
Data Table Title on Output(Boolean) Titles reports with name of data table.
Date Title on Output(Boolean) Titles reports with current date.
264
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Excel Has Labels(Boolean) When on, forces JMP to interpret the first row of data as
column labels.
Excel Selection(Boolean) When on, the user is prompted for which non‐blank Excel
worksheets should be imported from an Excel workbook.
File Location Settings(&lt;Directory Type&gt;(&quot;&lt;path&gt;&quot;&lt;,&quot;initial directory&quot;&gt;))
Valid directory types are:
Data Files Directory Sets the default location for data files.
Help Files Directory Sets the default location for help files.
Installation Directory By default, this location is set to the JMP installation folder:
On Windows: &quot;C:\Program Files\SAS\JMP\&lt;version number&gt;&quot;, &quot;C:\Program
Files\SAS\JMPPro\&lt;version number&gt;&quot;, or &quot;C:\Program Files\SAS\JMPSW\&lt;version
number&gt;&quot;
On Macintosh: &quot;\Library\Application Support\JMP\&lt;version number&gt;\&quot;
License File Path Sets the default location for JMP license file.
Preferences File Directory Sets the default location for the preferences settings file.
Save As Directory Sets the default location for Save As file operations.
Foreground Color(color) Sets the foreground color for windows.
Formula Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for the formula editor.
Graph Background Color(color) Sets the color for the background area inside the
graph frame.
Graph Marker Size(size) Default size for drawing markers.
Heading Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for table column headings in
reports.
Initial JMP Starter Window(Boolean) Specifies whether the JMP Starter window is
shown at launch.
Initial Splash Window(Boolean) Enables you to show or suppress the initial splash
screen.
Maximum JMP Call Depth(size) Sets the default for the maximum call depth (or stack
size) for JMP. Each thread that JMP creates has a 2MB stack by default. Resetting the
maximum call depth can cause a physical stack overflow.
Marker Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for markers used in plots.
Monospaced Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for monospaced text.
Evaluate OnOpen Scripts(&quot;always&quot;|&quot;never&quot;|&quot;prompt&quot;) Determines when an On
Open table script is run after the user opens the data table. By default, the user is
prompted. Their choice is remembered each time they open the data table in the current
JMP session. Scripts that execute other programs are never run.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
265
Outline Connecting Lines(Boolean) Draws lines between titles for same‐level outline
nodes.
Print Settings(option(value), ... ) Changes print options on the Page Setup
window:
Margins( &lt;n&gt;, &lt;n&gt;, &lt;n&gt;, &lt;n&gt;) sets the left, top, right, and bottom margins. Margins
are in inches.
Margins(&lt;n&gt;) sets all margins to the same value in inches.
Orientation(&quot;portrait&quot; | &quot;landscape&quot;) changes the page’s print orientation.
Headers(&lt;&quot;char&quot;&gt;, &lt;&quot;char&quot;&gt;, &lt;&quot;char&quot;&gt;) specifies text that appears in the left,
middle, and right header.
Headers(&lt;&quot;char&quot;&gt;) specifies the only text in the header.
Footers(&lt;&quot;char&quot;&gt;, &lt;&quot;char&quot;&gt;, &lt;&quot;char&quot;&gt;) specifies text that appears in the left,
middle, and right footer.
Footers(&lt;&quot;char&quot;&gt;) specifies the only text in the footer.
Scale(&lt;n&gt;) decreases or increases the percentage at which the content prints.
Show Explanations(Boolean) Some analyses have optional text that explains the output.
Show Menu Tips(Boolean) Turns menu tips on or off. (Windows only)
Show Status Bar(Boolean) Turns display of the status bar on or off.
Small Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for small text.
Text Font((&quot;font&quot;, size, &quot;style&quot;) Font choice for general text in reports.
Thin Postscript Lines(Boolean) Macintosh only. Specifies that line widths drawn to a
Postscript printer be narrower than otherwise.
Title Font(&quot;font&quot;, size, &quot;style&quot;) Font choice for titles. Arguments are name of font
(for example, &quot;Times&quot;), size in points, and style (&quot;bold&quot;, &quot;plain&quot;, &quot;underline&quot;,
&quot;italic&quot;).
Examples
The following expressions reset all preferences to their default values:
Preferences( &quot;Default&quot; );
Preferences( &quot;Factory Default&quot; );
Notes
The preferences for the following areas are not accessible in JSL: Text Data Files, Windows
Specific, Mac OS Settings, Fonts, Communications, Script Editor, and JMP Updates. See
“Platform Preferences(platform(option(value)), ...)” on page 261 for information about
setting platform preferences.
266
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Register Addin(&quot;unique_id&quot;, &quot;home_folder&quot;, &lt;named_arguments&gt;)
Description
Register a JMP Add‐In and load the add‐in if it registers successfully.
Returns
If successful, returns a scriptable object representing the registered add‐in. If unsuccessful,
returns Empty.
Arguments
unique_id A quoted string that contains the unique identifier for the add‐in. The string
can contain up to 64 characters. The string must begin with a letter and contain only
letters, numbers, periods, and underscores. Reverse‐DNS names are recommended to
increase the likelihood of uniqueness.
home_folder A quoted string that contains the filepath for the folder containing the
add‐in files. The filepath must conform to the valid pathname requirement for the host
operating system.
DisplayName( &quot;name&quot; ) An optional, quoted string that contains a name that can be
displayed in the JMP user interface wherever add‐in names are displayed, instead of the
unique ID.
JMPVersion(&quot;version&quot;) An optional string that contains a specific version of JMP. The
default value is ʺAllʺ, which enables the add‐in to be loaded and run in any version of
JMP that supports add‐ins. ʺCurrentʺ restricts the use of the add‐in to only the current
version. Any quoted version number (for example, ʺ7ʺ or ʺ9ʺ) restricts the add‐in to a
single specific version of JMP.
LoadsAtStartup(Boolean) An optional Boolean. The default value is True (1), which
causes the add‐in to be loaded when JMP is started. If the value is False (0), the add‐in is
not loaded automatically.
LoadNow(Boolean) Loads the add‐in immediately.
Note
If a file named addin.def is found in the specified home folder, values from that file are used
for any optional arguments that are not included in the Register Addin() function.
Example
In the following example, the first argument is the unique identifier. The second argument
identifies where the add‐in is installed. The third argument is the name that appears where
add‐in names are displayed (for example, the View &gt; Add-Ins menu on Windows).
Register Addin(&quot;com.company.lee.dan.MyAddIn&quot;,&quot;$DOCUMENTS/myaddin&quot;,
displayname( &quot;Calculator Addin&quot; ));
The second argument becomes the $ADDIN_HOME path variable definition. When you refer to
the add‐in scripts, be sure to include a trailing slash after the path variable.
Include(&quot;$ADDIN_HOME(com.jmp.jperk.texttocols)/texttocols.jsl&quot;);
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
267
Revert Menu()
Description
Resets your JMP menus to factory defaults.
Run Program(Executable(&quot;path/filename.exe&quot;), Options({&quot;/a&quot;, &quot;/b&quot;, &quot;...&quot;}),
Read Function(expression), Write Function(expression),
Parameter(expression))
Description
Runs the external program specified by the Executable argument, with the command line
arguments specified by the Options argument.
Results
Returns either a string, a blog, or a Run Program object as controlled by the Read Function
argument.
Arguments
Executable The path to the executable. On Macintosh, type the full path to the executable.
Options Command line arguments for the executable.
Read Function If Read Function( &quot;text&quot; ) is specified, a text string is returned. If Read
Function( &quot;blob&quot; ) is specified, a blob is returned. The script waits until the external
program closes its stdout. Run Program then returns all data that the external program
has written to its stdout as a string or a blob.
If Read Function is not specified, a Run Program object is returned.
Write Function Optional argument that accepts a function as its value; it does not accept
&quot;text&quot; or &quot;blob&quot;.
Parameter Optional argument to read and write the expression in Read Function.
Notes
•
The Run Program object, which is returned if Read Function is not specified, accepts the
following messages to read data from the external program’s stdout:
‒ &lt;&lt;Read: reads any available data as a string. If no data is available, an empty string is
returned.
‒ &lt;&lt;Can Read: returns true if there is data available to be read.
‒ &lt;&lt;Is ReadEOF: returns true when the external program has completed and all its data
has been read.
You can use these messages to poll for data and process the data as it is produced by the
external program.
•
A Run Program object accepts the following messages to write data to the external
program’s stdin:
‒ &lt;&lt;Write( &quot;text&quot; ): sends data to the external program’s stdin.
268
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
‒ &lt;&lt;Can Write: returns true if the external program will accept data immediately;
otherwise, calling &lt;&lt;Write causes your script to block.
‒ &lt;&lt;WriteEOF: signals to the external program that you are done sending data to it.
•
Instead of sending messages to the returned Run Program object, you can specify the Read
Function argument as an inline function. RP is the Run Program object.
RP = Run Program(
Executable( ... ),
Read Function(
Function( {RP},
&lt;your code here&gt;
RP &lt;&lt; Read
)
)
);
The Parameter(optParm) argument is optional in Read Function. If specified, the functions
defined for Read Function and Write Function can receive a second argument, which is
the value of optParm.
•
Use global variables when Run Program() is inside a function.
Examples
The following script is an example of the Write Function argument. RP is the Run Program
object. In this context, it accepts the &lt;&lt;Write and &lt;&lt;WriteEOF messages.
RP = Run Program(
Executable( ... ),
Write Function(
Function( {RP},
&lt;your code here&gt;
RP &lt;&lt; Write( &quot;Program finished.&quot; )
)
)
);
The following script shows an example of Parameter(optParm) argument:
RP = Run Program(
Executable( ... ),
Parameter( x ),
Read Function( Function( {RP, optParm},... ) )
);
Within the Read Function, optParm contains the value of x. Do not attempt to access the
optParm argument in your function if you have not specified a Parameter argument.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
269
Schedule(n, script)
Description
Queues an event to run the script after n seconds.
Set Clipboard(string)
Description
Evaluates the &quot;string&quot; argument looking for a character result, and then places the string
on the clipboard.
SetJVMOption( Version(&quot;&lt;version&gt;&quot;) )
Description
Sets the Java Runtime Environment (JRE) version that you want JMP to use (rather than the
version installed with JMP). This script must be run before JMP connects to the JRE.
Argument
version (Windows only) In the Windows registry, there are two requirements for the
JavaSoft\Java Runtime Environment key: the key must include a string called
“RuntimeLib” that points to a valid jvm.dll. And the Java Runtime Environment key must
include a key named after the quoted JVM version number.
Set Platform Preference()
Set Platform Preferences()
See “Platform Preferences(platform(option(value)), ...)” on page 261.
Set Preference()
Set Preferences()
See “Preferences(pref1(value1), ...)” on page 263.
Set Toolbar Visibility( &quot;toolbar name&quot; | default | all, window type | all,
&quot;true&quot; | &quot;false&quot; )
Description
On Windows, shows or hides a toolbar based on the window type or for all windows.
Arguments
toolbar name | default | all The internal name of the toolbar (see the View &gt;
Toolbars list in JMP), the default toolbar for the specified window type, or all toolbars.
Include quotes around &quot;toolbar name&quot;.
window type | all Data table, script, report, journal, or all windows.
270
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
true | false Quoted string that shows or hides the toolbar.
Shortest Edit Script()
Description
Compares two lists, strings, matrices, or sequences. See the Scripting Index in the JMP Help
menu for more detailed syntax options.
Arguments
limit An optional argument that stops the evaluation when the edit list exceeds the
specified number of inserted or deleted items.
Show Addins Dialog()
Description
Opens the Add‐In Status window (View &gt; Add-Ins).
Arguments
None.
Show Commands()
Description
Lists scriptable objects and operators. Arguments are All, DisplayBoxes, Scriptables,
Scriptable Objects, StatTerms, Translations.
Show Preferences(&lt;&quot;all&quot;&gt;)
Description
Shows current preferences. If no argument is specified, preferences that have been changed
are shown. If &quot;all&quot; is given as the argument, all preferences are shown.
Show Properties(object)
Description
Shows the messages that the given object can interpret, along with some basic syntax
information.
Sobol Quasi Random Sequence(nDim, nRow)
Description
Generates a sequence of space‐filling quasi random numbers using the Sobol sequence in
up to 4000 dimensions.
Chapter 2
JSL Syntax Reference
JSL Functions
Utility Functions
271
Socket(&lt;STREAM | DGRAM&gt;)
Description
Creates a socket.
Returns
The socket that was created.
Arguments
STREAM | DGRAM Optional argument to specify whether the socket is a stream or datagram
socket. If no argument is supplied, a stream socket is created.
Speak(text, &lt;wait(Boolean)&gt;)
Description
Calls system’s speech facilities to read aloud the text. If Wait is turned on, script execution
pauses until speaking is done.
Status Msg(&quot;message&quot;)
Description
Writes the message string to the status bar.
Subtract(a, b)
a-b-...
Description
Subtracts the values of the listed arguments, left to right. No arguments are changed.
Returns
The difference.
Arguments
Two or more variables, numbers, or matrices.
Notes
Two or more arguments are permitted. Specifying fewer than two arguments produces an
error.
See Also
The Data Structures chapter in the Scripting Guide.
Unregister Addin(&quot;unique_id&quot;)
Description
Unregisters (removes) a previously registered add‐in.
272
JSL Functions
Utility Functions
Chapter 2
JSL Syntax Reference
Argument
unique_id A quoted string that contains the unique identifier for the add‐in to unregister.
Web(string, &lt;JMP Window&gt;)
Description
Opens the URL stored in string in the default system web browser. Under Microsoft
Windows, you can add JMP Window as the second argument to have the HTML open in a
JMP browser.
The http:// prefix in the URL is optional.
Examples
url=&quot;www.jmp.com&quot;;
Web(url);
Web(&quot;www.jmp.com&quot;);
Web(&quot;www.jmp.com&quot;, JMP Window);
XML Attr(&quot;attr name&quot;)
Description
Extracts the string value of an xml argument in the context of evaluating a Parse XML
command
XML Decode(&quot;xml&quot;)
Description
Decodes symbols in XML to ordinary text. For example, &amp;amp; becomes &amp;, and &amp;lt;
becomes &lt;.
Argument
xml A quoted string containing XML.
XML Encode(&quot;text&quot;)
Description
Prepares text for embedding in XML. For example, &amp; becomes &amp;amp;, and &lt; becomes &amp;lt;.
Argument
xml A quoted string containing plain text.
Chapter 2
JSL Syntax Reference
JSL Functions
Platform Scripting Notes
273
XML Text()
Description
Extracts the string text of the body of an XML tag in the context of evaluating a Parse XML
command.
Platform Scripting Notes
Fit Model
Fit Group ( model1, model2, ...);
Fit Group ( model1; model2; ...);
Description
Groups separate Fit Models (for example, least squares, nonlinear, neural, gaussian
processing, and mixed) in the same output window with a shared Profiler.
Arguments
model1, model2 Specifies the profiled fit model and its arguments.
Scripting Options for All Platforms
The following messages are available for any platform object only in JSL:
object
object
object
object
object
object
object
object
object
object
object
&lt;&lt;Get Script
&lt;&lt;Get Script With Data Table
&lt;&lt;Get Data Table
&lt;&lt;Get Timing
&lt;&lt;Report
&lt;&lt;Top Report
&lt;&lt;Title
&lt;&lt;SendToReport( Dispatch(...) )
&lt;&lt;SendToByGroup( ... )
&lt;&lt;Action
&lt;&lt;Ignore Platform Preferences( 0|1 )
Individual Platform Options
Each platform has preferences configurable using File &gt; Preferences &gt; Platforms. Each
platform’s options are scriptable. For detailed information about scripting platform
preferences, refer to the JMP Scripting Index. In JMP, select Help &gt; Scripting Index for details.
274
JSL Functions
Platform Scripting Notes
Chapter 2
JSL Syntax Reference
Distribution
The following message for a Distribution object is available only in JSL:
dist_object &lt;&lt;(Fit Handle[n] &lt;&lt; ...)
The following JSL option for Fit Distribution() is equivalent to the Make into Data Table
option on the right‐click menu for the Parameter Estimates table:
Fit Distribution(
&lt;distribution&gt;( &quot;Make Parms Table&quot; )
);
Bivariate
To turn off specific fits for a Bivariate object, set the fit to 0:
Bivariate(
Y( :height ),
X( :weight ),
fit mean(1), // enables fit
Density Ellipse( 0 ), // disables fit
Fit Orthogonal( 0 ),
Fit Line( 0 ),
Fit Polynomial( 0 ),
Fit spline( 0 ),
fit robust(0),
fit each value(0),
histogram borders(0),
nonpar density(0)
);
The following message for a Bivariate object is available only in JSL:
biv_object &lt;&lt;Fit Where( WHERE_clause )
Fit Model
The following messages for a Fit Model object are available only in JSL:
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
fit_model_object
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
Variance Components( );
Effect Names( );
Effect PValues( );
Estimates( );
Parameter Names( );
Random Effect Names( );
Std Errors( );
X Matrix( );
XPX Inverse( );
Y Matrix( );
Chapter 2
JSL Syntax Reference
JSL Functions
Platform Scripting Notes
275
Fit Model: Standard Least Squares
Saving Prediction Formulas as SQL Expressions
In Standard Least Squares, save prediction formulas as SQL expressions using Get SQL
Prediction Expression(). For an example, see the JMP Scripting Index on the Help menu.
Fitting Models that Have Missing Y Values and Only Fixed Effects
In models that contain a random effect, Y values are fit separately by default. However,
suppose that your model contains only fixed effects. You enter more than one Y response,
some of which have missing values.
•
In a script, the Y responses are fit together by default. The model fits each Y using only
those rows that are nonmissing for all of the Y variables. For example, a row that includes
one or more missing Y values is excluded from the model. You can explicitly include
Run( &quot;Fit Together&quot; ) in a script to get the same result.
•
If you include the Run( &quot;Fit Separately&quot; ) option, the model fits each Y using all rows
that are nonmissing for that particular Y. For example, a row that includes one or more
missing Y values is included in the model.
The following script fits the Y responses together:
dt &lt;&lt; Fit Model(
Y( :height, :weight ),
Effects( :sex ),
Personality( &quot;Standard Least Squares&quot; ),
Emphasis( &quot;Minimal Report&quot; ),
Run // or Run( &quot;Fit Together&quot; )
);
The following script fits the Y responses separately:
dt &lt;&lt; Fit Model(
Y( :height, :weight ),
Effects( :sex ),
Personality( &quot;Standard Least Squares&quot; ),
Emphasis( &quot;Minimal Report&quot; ),
Run( &quot;Fit Separately&quot; )
);
In JMP, the user is prompted to select Fit Together or Fit Separately when running the model.
See the Standard Least Squares chapter in Fitting Linear Models for details about how missing
Y values are handled.
Fit Model: MANOVA
The following message for a Fit Model object is available only in JSL:
276
JSL Functions
Platform Scripting Notes
Chapter 2
JSL Syntax Reference
fit_model_object &lt;&lt; (Response[1] &lt;&lt; (Effect[1] &lt;&lt; ... ) );
Fit Model: Generalized Linear Models
The following message for a Fit Model object is available only in JSL:
Parametric Formula( )
Fit Model: Nominal Logistic
The following messages for a Fit Model Nominal Logistic object are available only in JSL:
fit_model_object &lt;&lt; Get SAS Data Step
fit_model_object &lt;&lt; Get MM SAS Data Step
Fit Model: Ordinal Logistic
The following messages for a Fit Model Ordinal Logistic object are available only in JSL:
fit_model_object &lt;&lt; Get SAS Data Step
fit_model_object &lt;&lt; Get MM SAS Data Step
Neural
The Neural platform replaces Neural Net. Scripts that use Neural Net are deprecated and
might not work in the future. We recommend that you use the Neural platform for new scripts
and change your old scripts that use Neural Net to Neural.
The following options for Neural() are available only in JSL:
Multithreading( Boolean )
Set Random Seed( n )
The following message for a Neural object is available only in JSL:
neural_object &lt;&lt;Get NBoost
The following messages for a Neural Fit object are available only in JSL:
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
RSquare Training)
RSquare Validation)
RSquare Test)
Gen RSquare Training)
Gen RSquare Validation)
Gen RSquare Test)
Misclassification Rate Training)
Misclassification Rate Validation)
Misclassification Rate Test)
Average Log Error Training)
Average Log Error Validation)
Chapter 2
JSL Syntax Reference
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
neural_object
JSL Functions
Platform Scripting Notes
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;(Fit[n]
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
Average Log Error Test)
RMS Error Training)
RMS Error Validation)
RMS Error Test)
Average Absolute Error Training)
Average Absolute Error Validation)
Average Absolute Error Test)
ROC Area Training)
ROC Area Validation)
ROC Area Test)
Confusion Matrix Training)
Confusion Matrix Validation)
Confusion Matrix Test)
Confusion Rates Training)
Confusion Rates Validation)
Confusion Rates Test)
Seconds)
Partition
The following options for Partition() are available only in JSL:
Missing Value Categories( Boolean )
Set Random Seed( n )
Multithreading( Boolean )
Time Limit ( n )
The following messages for a Partition object are available only in JSL:
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
RSquare Training
RSquare Validation
RSquare Test
Gen RSquare Training
Gen RSquare Validation
Gen RSquare Test
Misclassification Rate Training
Misclassification Rate Validation
Misclassification Rate Test
ROC Area Training
ROC Area Validation
ROC Area Test
Average Log Error Training
Average Log Error Validation
Average Log Error Test
RMS Error Training
RMS Error Validation
RMS Error Test
Average Absolute Error Training
277
278
JSL Functions
Platform Scripting Notes
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
partition_object
Chapter 2
JSL Syntax Reference
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
Average Absolute Error Validation
Average Absolute Error Test
Seconds
SAS Data Step
Tolerant SAS Data Step
MM SAS Data Step
MM Tolerant SAS Data Step
Time Series
The following options for Time Series() are available only in JSL:
Autocorrelation Lags( n )
Forecast Periods( n )
The following messages for a Time Series object are available only in JSL:
time_series_object &lt;&lt;Maximum Iterations( n )
time_series_object &lt;&lt;Get Models
time_series_object &lt;&lt;Get Model Specs
Choice
The following option for Choice() is available only in JSL:
Convergence Criterion( fraction )
Multivariate
The following message for a Multivariate object is available only in JSL:
multivariate_object &lt;&lt; Create SAS Job( )
Hierarchical Clustering
The following messages for a Hierarchical cluster object are available only in JSL:
hier_cluster_object
hier_cluster_object
hier_cluster_object
hier_cluster_object
hier_cluster_object
&lt;&lt;Get Column Names
&lt;&lt;Get Clusters
&lt;&lt;GetDisplayOrder
&lt;&lt;GetColumnDisplayOrder
&lt;&lt;Get Distance Matrix
KMeans Clustering
The following message for a KMeans cluster object is available only in JSL:
kmeans_cluster_object &lt;&lt;Get Statistics
Chapter 2
JSL Syntax Reference
JSL Functions
Platform Scripting Notes
Life Distribution
The following messages for a Life Distribution object are available only in JSL:
life_dist_object
life_dist_object
life_dist_object
life_dist_object
&lt;&lt;Suppress Plot(plot_name)
&lt;&lt;Get Results
&lt;&lt;Get Estimates
&lt;&lt;Get Formula
Fit Life by X
The following messages for a Fit Life by X object are available only in JSL:
fit_life_object &lt;&lt;Set Scriptables( ... )
fit_life_object &lt;&lt;Get Results
Fit Parametric Survival
The following messages for a Fit Parametric Survival object are available only in JSL:
survival_object
survival_object
survival_object
survival_object
survival_object
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
&lt;&lt;Get
Parameter Names
Estimates
Std Errors
Effect Names
Effect PValues
Control Chart
The following option for Control Chart() is available only in JSL:
Use Excluded Points on MR( Boolean )
Variability Chart
The following message for a Variability Chart object is available only in JSL:
variability_object &lt;&lt;Show Box Plot Whisker Bars( Boolean )
Pareto Plot
The following message for a Pareto Plot object is available only in JSL:
No Plot(Boolean)
Partial Least Squares
The Partial Least Squares (PLS) platform has replaced PLS. Scripts that use PLS might not
work in the future. We recommend that you update your old scripts to use Partial Least
Squares instead of PLS and use Partial Least Squares in the future.
279
280
JSL Functions
Platform Scripting Notes
Chapter 2
JSL Syntax Reference
Profiler
The following messages for a Profiler object are available only in JSL:
profiler_object &lt;&lt;Get Objective
profiler_object &lt;&lt;Objective Formula
profiler_object &lt;&lt;Get Objective Formula
Surface Plot
The following messages for a Surface Plot object are available only in JSL:
surface_plot_object
surface_plot_object
surface_plot_object
surface_plot_object
surface_plot_object
&lt;&lt;Mode( &quot;Isosurface&quot; | &quot;Sheet&quot; )
&lt;&lt;Set Z Axis( col, Current Value( n ) )
&lt;&lt;Set Variable Axis( col, Current Value( n ) )
&lt;&lt;Response( ... )
&lt;&lt;Formula( ... )
Chapter 3
JSL Messages
Summary of Messages for Objects and Display Boxes
This topic provides abbreviated descriptions for many of JMP’s general object messages. For
complete information about object messages, see the JMP Scripting Index. In JMP, select Help &gt;
Scripting Index.
For information about platform messages, see the Scripting Platforms chapter in the Scripting
Guide.
Contents
Alpha Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Associative Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Data Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Data Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Datafeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Display Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Dynamic Link Libraries (DLLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
R Integration Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
SAS Integration Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Sockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Tree Node and Tree Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Triangulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Other Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Chapter 3
JSL Syntax Reference
JSL Messages
Alpha Shape
283
Alpha Shape
For the following messages, ashape stands for an alpha shape or a reference to one.
ashape &lt;&lt;Get Alpha
Returns the current alpha value.
ashape &lt;&lt;Set Alpha(alpha)
Sets the current alpha value and recomputes the triangulation.
ashape &lt;&lt;Get Tri Alpha
Returns the alpha values for each triangle.
Associative Arrays
For the following messages, map stands for an associative array or a reference to one.
map&lt;&lt;First
Returns the first key within map, or Empty() if map has no keys. Note that keys are returned
in lexicographical order.
map&lt;&lt;Get Contents
Returns a list of all key‐value pairs within map.
map&lt;&lt;Get Keys
Returns a list of all the keys within map.
map&lt;&lt;Get Default Value()
Returns the implicit value of all absent keys, or Empty() if none has been set.
map&lt;&lt;Get Value(key)
Returns the value for the key within map.
map&lt;&lt;Get Values(&lt;keylist&gt;)
If no argument is provided, a list of all values within map is returned.
284
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
If a list of keys is provided, a list of the values corresponding to only those keys is returned.
map&lt;&lt;Insert(key, value)
Inserts the key into map and assigns value to it. If key already exists in map, its value is
replaced by the new value given. This message is equivalent to the function Insert Into.
map&lt;&lt;Next(key)
Returns the key following the given key within the map, or Empty() if map has no keys. Note
that keys are returned in lexicographical order.
map&lt;&lt;Remove(key)
Removes the key and value from map. This message is equivalent to the function Remove
From.
map&lt;&lt;Set Default Value(v)
Sets the implicit value of all absent keys. Any key added without a value is assigned this
value by default.
Data Tables
dt&lt;&lt;Add Column Properties(property argument, ...)
Add the specified properties to the selected column.
dt&lt;&lt;Add Multiple Columns(&quot;prefix&quot;, n, position, attributes)
Adds n columns to dt at the position indicated.
dt&lt;&lt;Add Rows(count, &lt;rownum&gt;)
dt&lt;&lt;Add Rows(assignment list)
Add the number of rows specified to the bottom of the data table or starting at the rownum
specified.
dt&lt;&lt;Add Scripts to Table(script, ...)
dt&lt;&lt;Add Properties to Table(script, ...)
Pastes the specified scripts to the data table.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
285
dt&lt;&lt;Anonymize(&lt;columns(list)&gt;, &lt;Output Table Name(string)&gt;);
Removes unique identifiers from data, some column properties, and table scripts. Applies
to a data table or selected columns. Continuous columns are not affected.
dt&lt;&lt;Begin Data Update
Turns off display updating to allow for quick updating of a data table. Use End Data
Update in conjunction with this command to turn display updating back on.
dt&lt;&lt;Clear Column Selection
Deselects all selected columns.
dt&lt;&lt;Clear Row States
Cancels any row states in effect.
dt&lt;&lt;Clear Select
Turns off the current selection.
dt&lt;&lt;Clone Formula Column(column, n, Substitute Column
Reference(column1, {list}))
Creates n new formula columns, substituting references to column1 with columns from the
list into the formula from the original column.
dt&lt;&lt;Close Data Grid(Boolean)
Closes the data table grid.
dt&lt;&lt;Close Side Panels(Boolean)
Closes the side panel in a data table.
dt&lt;&lt;Color or Mark by Column(col, &lt;optional arguments&gt;)
dt&lt;&lt;Color by Column(col, &lt;optional arguments&gt;)
Function
Assigns colors or markers according to the values of a data table column. If no optional
arguments are provided, row states are used.
Arguments
Color Number(n) Uses the specified quoted JMP color.
Color Theme(&quot;theme&quot;) Uses the specified quoted color theme.
286
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
Marker Theme(&quot;named argument&quot;) Uses the specified quoted marker theme:
&quot;standard&quot;, &quot;hollow&quot;, &quot;paired&quot;, &quot;classic&quot;, or &quot;alphanumeric&quot;.
Continuous Scale For Color by Column, assigns colors in a chromatic sequential fashion
based on the values in the highlighted column.
Reverse Scale Reverses the color scheme in use.
Excluded Rows Applies the row states to excluded columns.
Make Window with Legend Creates a separate window with a legend.
dt&lt;&lt;Color Rows by Row State
Colors the rows in the data table grid using the color assignments by row states. Send the
message again to turn off the row colors.
dt&lt;&lt;Compress Selected Columns({column1, ...})
Compresses the listed columns into the most compact form that is possible. Columns with
character data are compressed to 1 byte if there are fewer than 255 levels. Columns with
numeric data are compressed to 1 byte if the numeric values are between ‐127 and 127.
dt&lt;&lt;Concatenate(dt2, ..., Keep Formulas, Output Table Name(&quot;name&quot;))
Creates a new table (&quot;name&quot;) from the rows of dt and dt2.
dt&lt;&lt;Copy Table Script
Copies the script to recreate the data table onto the clipboard so that it can be pasted
somewhere else.
dt&lt;&lt;Data Filter(&lt;Mode(...)&gt;, &lt;Add Filter (...)&gt;)
Constructs a data filter. If no arguments are specified, the Add Filter Columns window
appears.
Arguments for Mode() include Select(), Show(), and Include(). They are all Boolean.
Select defaults to true(1), and Show and Include default to false (0).
Arguments for Add Filter() include Columns(), and Where(). Columns() takes one or
more column names separated by commas. You can add one or more WHERE clauses to
define the filter.
There are several additional arguments. For more information, see the Data Filter chapter
in the Using JMP and the Data Tables chapter in the Scripting Guide.
dt&lt;&lt;Get Header Height
Returns the column header’s display height (in pixels).
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
287
dt&lt;&lt;Data View(&lt;&quot;options&quot;&gt;)
Duplicates the data table in a new window. If you specify one of the following quoted
arguments, the new data table includes only the corresponding rows.
excluded Quoted. The new data table includes only the rows that are marked as excluded
in the original data table.
labeled | labelled Quoted. The new data table includes only the rows that are marked
as labeled in the original data table.
hidden Quoted. The new data table includes only the rows that are marked as hidden in
the original data table.
selected Quoted. The new data table includes only the rows that are selected in the
original data table.
dt&lt;&lt;Delete Columns(col, col2, ...)
dt&lt;&lt;Delete Column
Deletes column(s) from the data table dt. Specify which column or columns to delete.
Without an argument, deletes the selected columns, if any. Delete Column is a synonym.
dt&lt;&lt;Delete Rows(&lt;n&gt;)
dt&lt;&lt;Delete Rows({n, o, p, ...})
dt&lt;&lt;Delete Rows({n::q})
Deletes the currently selected rows or rows specified.
dt&lt;&lt;Delete Table Property(&quot;name&quot;)
Deletes a table property (for example, a script).
dt&lt;&lt;Delete Table Variable(&quot;name&quot;)
Deletes a table variable.
dt&lt;&lt;End Data Update
Resumes display updating after a Begin Data Update message. These commands are used
for quick updates of the data table when many changes have to be made. Speed is gained
by turning off display updating.
288
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dt&lt;&lt;Exclude
dt&lt;&lt;Unexclude
Toggles selected rows in dt from excluded to unexcluded or vice versa.
dt&lt;&lt;Get All Columns As Matrix
Returns the values from all columns of dt in a matrix. Character columns are numbered
according to the levels, starting at 1.
dt&lt;&lt;Get As Matrix
Returns values from the numeric columns of dt in a matrix.
dt&lt;&lt;Get As Report
Returns the data table as a report.
dt&lt;&lt;Get Column Names(&quot;arguments&quot;)
Returns a list of column names in a data table. The &quot;arguments&quot; restrict the names
retrieved as follows:
&quot;Numeric&quot;, &quot;Ordinal&quot;, &quot;Rowstate&quot;, &quot;Continuous&quot;, &quot;Ordinal&quot;, and &quot;Nominal&quot; get only the
specified types of columns. More than one can be specified. &quot;String&quot; returns a list of
strings rather than a list of column references.
dt&lt;&lt;Get Column Reference(list or matrix of col names)
Returns the column reference of the strings in the list or matrix. If no list or matrix is used,
JMP returns all column names.
dt&lt;&lt;Get Display Width
Returns the column display width in pixels.
dt&lt;&lt;Get Excluded Rows
Returns the currently excluded rows in the data table.
dt&lt;&lt;Get Hidden Rows
Returns the currently hidden rows in the data table.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
289
dt&lt;&lt;Get Labeled Columns
dt&lt;&lt;Get Labelled Columns
Returns the currently labeled columns in the data table.
Example
In PopAgeGroup.jmp, the Country and Year columns are labeled. The following script returns
a list of the labeled column names.
dt = Open( &quot;$SAMPLE_DATA/PopAgeGroup.jmp&quot; );
dt &lt;&lt; Get Labeled Columns;
{:Country, :Year}
dt&lt;&lt;Get Labeled Rows
dt&lt;&lt;Get Labelled Rows
Returns the currently labeled rows in the data table.
dt&lt;&lt;Get Name
Returns the name of the table.
dt&lt;&lt;Get Path
Returns the absolute path for the data table.
dt&lt;&lt;Get Property(&quot;name&quot;)
Returns the script in the property name.
dt&lt;&lt;Get Row Change Function
Returns the expression that is evaluated when a row is selected.
dt&lt;&lt;Get Row ID Width
Returns the row ID display width in pixels.
dt&lt;&lt;Get Rows Where(WHERE clause)
Returns the rows in the data table that match the specified where criteria. Some examples
are as follows:
dt&lt;&lt;Get Rows Where(:sex == &quot;M&quot;);
dt&lt;&lt;Get Rows Where(:sex == &quot;M&quot; &amp; :age &lt; 15);
290
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dt&lt;&lt;Get Script
Returns as an expression a script to recreate the data table.
dt&lt;&lt;Get Selected Columns(&lt;&quot;string&quot;&gt;)
Returns a list of selected columns as column references. Include the &quot;string&quot; argument to
return the selected columns in a string.
Examples
dt &lt;&lt; Get Selected Columns();
{:age, :sex, :height}
dt &lt;&lt; Get Selected Columns( &quot;string&quot; );
{&quot;age&quot;, &quot;sex&quot;, &quot;height&quot;}
dt&lt;&lt;Get Selected Rows()
Returns the selected rows.
dt&lt;&lt;Get Table Script Names()
Returns a list of the names of all the scripts and properties in the data table.
dt&lt;&lt;Get Table Variable(&quot;name&quot;)
Returns the value from the variable or script name.
dt&lt;&lt;Get Table Variable Names()
Returns a list of the names of all the variables in the data table.
dt&lt;&lt;Go To Row(n)
Locates and selects row number n in dt.
dt&lt;&lt;Group Columns({col1, col1, ...})
dt&lt;&lt;Group Columns(&quot;group name&quot;, col, n)
Groups the columns specified under the specified group name. You can provide either a list
of columns to group, or a column name and the number of columns to group. In the latter
case, the number n specifies to group the column given with the n‐1 columns that follow.
dt&lt;&lt;Hide
dt&lt;&lt;Unhide
Toggles selected rows in dt from hidden to unhidden or vice versa.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
291
dt&lt;&lt;Invert Row Selection
Selects any row currently deselected and deselects any row currently selected.
dt&lt;&lt;Is Dirty
Returns 1 if the table has been modified from its saved state. Otherwise, returns 0.
dt&lt;&lt;Join(With(table), Select(columns), Select With(columns), method,
Drop Multiples(Boolean, Boolean), Include Non Matches(Boolean,
Boolean), Output Table Name(&quot;name&quot;))
Combines data tables dt and table side to side. For details about joining tables, see the
Using JMP book.
dt&lt;&lt;Journal
Makes a journal from the data table. Only the data grid is included, not notes, variables, or
scripts.
dt&lt;&lt;Journal Link
Adds a link to the data table in the current journal. If a journal does not exist, a new one is
created.
dt&lt;&lt;Label
dt&lt;&lt;Unlabel
Toggles selected rows in dt from labeled to unlabeled or vice versa.
dt&lt;&lt;Last Modified
Returns the date on which the data table was last saved.
dt&lt;&lt;Layout
Makes a layout window from the data table. Only the data grid is included, not notes,
variables, or scripts.
dt&lt;&lt;Lock Data Table
Locks the data table so that data and column properties cannot be added or changed.
292
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dt&lt;&lt;Make RowState Handler
Creates a row state handler function. The argument of the function holds the rows whose
row states get changed.
dt&lt;&lt;Make SAS Data Step
Returns the data table as a SAS Data Step.
dt&lt;&lt;Make SAS Data Step Window
Returns the data table as a SAS Data Step and places it in a SAS script window.
dt&lt;&lt;Marker by Column(col)
Assigns markers according to the values of a data table column.
dt&lt;&lt;Markers(n)
Assigns marker n to the selected rows.
dt&lt;&lt;Maximize Display
Forces the data table to remeasure all of its columns and zoom to the best‐sized window.
dt&lt;&lt;Move Selected Columns(&quot;To First&quot;|&quot;To Last&quot;|After(col))
Moves the selected columns in the data table to the specified position.
dt&lt;&lt;Move Rows(&quot;At Start&quot;|&quot;At End&quot;|After(n))
Moves the selected rows in the data table to the specified position.
dt&lt;&lt;New Column(&quot;name&quot;, attributes)
Adds a new column named &quot;name&quot; after the last column in dt. Can also be used as a
command: New Column(&quot;name&quot;, attributes).
dt&lt;&lt;New Data Box()
Makes a data table view in a display box tree.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
293
dt&lt;&lt;New Data View
Opens a duplicate of the data table. The second data table is identical to and linked to the
original data table, so that any changes made in one are reflected in the other. Closing either
data table also closes the other and all references to the data tables are deleted.
This can be useful to show an invisible data table.
dt&lt;&lt;New Script(&quot;name&quot;, script)
dt&lt;&lt;Set Property(&quot;name&quot;, script)
Creates a new table property using the specified name that stores the specified script.
Use New Script() or Set Property() rather than the deprecated New Property() and New
Table Property().
dt&lt;&lt;New Table Variable(&quot;name&quot;, value)
dt&lt;&lt;Set Table Variable(&quot;name&quot;, value)
Creates a new table variable with the specified name and value.
dt&lt;&lt;Next Selected
Scrolls data table down to show the next selected row that is not already in view.
dt&lt;&lt;Original Order
Restores saved order of columns in dt.
dt&lt;&lt;Previous Selected
Scrolls data table up to show the previous selected row that is not already in view.
dt&lt;&lt;Print Window(&lt;&quot;Show Dialog&quot;&gt;)
Prints the window. If the optional argument &quot;Show Dialog&quot; is specified, the print window
is displayed. Otherwise, the window is printed to the default printer using the current
settings, and no print window is displayed.
dt&lt;&lt;Reorder By Data Type
Reorders columns in dt, row state first, then character, then numeric.
dt&lt;&lt;Reorder By Modeling Type
Reorders columns in dt to continuous, then ordinal, then nominal.
294
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dt&lt;&lt;Reorder By Name
Reorders columns in dt to alphanumeric order by name.
dt&lt;&lt;Rerun Formulas
Recalculates all formula‐based data table variables. Recalculations are performed in the
proper dependency order.
dt&lt;&lt;Reverse Order
Reverses columns in dt from current order.
dt&lt;&lt;Revert
Reverts to the most recently saved version of dt.
dt&lt;&lt;Run Formulas
Performs all pending formula evaluations, including evaluations that are pending as a
result of evaluating other formulas.
dt&lt;&lt;Run Script(&quot;name&quot;)
Finds the table property name and runs it as a JSL script.
dt&lt;&lt;Save(&quot;path&quot;)
dt&lt;&lt;Save As(&quot;path&quot;)
Saves the table under the ʺpathʺ given.
dt&lt;&lt;Save Database(&quot;connection_information&quot;, &quot;table_name&quot;, &lt;Replace&gt;)
Save the data table to the database named using the connection and table name specified.
The Replace option replaces the existing database with the current database.
dt&lt;&lt;Save Script to Script Window
Saves a script to reproduce the data table in a Script Journal window.
dt&lt;&lt;Select All Rows
Selects all rows in the data table.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
dt&lt;&lt;Select Excluded
Selects only those rows in the data table that are currently excluded.
dt&lt;&lt;Select Hidden
Selects only those rows in the data table that are currently hidden.
dt&lt;&lt;Select Labeled
Selects only those rows in the data table that are currently labeled.
dt&lt;&lt;Select Randomly(p|n)
Randomly selects the given percentage p of the rows in the data table, or the number of
rows n.
dt&lt;&lt;Select Rows({list})
Selects the rows given in the list of row numbers.
dt&lt;&lt;Select Where(condition)
Selects the rows in dt where the condition evaluates as true.
dt&lt;&lt;Set Dirty
Marks the data table as changed, even if no changes have been made.
dt&lt;&lt;Set Header Height(num)
Sets the column header’s display height to the number of specified pixels.
dt&lt;&lt;Set Label Columns(column_1, ...)
Assigns the specified columns as label columns.
dt&lt;&lt;Set Matrix(matrix)
Inserts matrix into a data table, adding new columns and rows as necessary.
dt&lt;&lt;Set Name(&quot;name&quot;)
Gives a &quot;name&quot; to the table.
295
296
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dt&lt;&lt;Set Property(&quot;name&quot;, script)
See “dt&lt;&lt;New Script(ʺnameʺ, script)” on page 293.
dt&lt;&lt;Set Label Columns(&quot;name&quot;, ...)
dt&lt;&lt;Set Label Columns
Turns on the Label attribute for the specified columns. If no columns are listed, turns Label
attribute off.
dt&lt;&lt;Set Row ID Width(expr)
Sets the row ID display width to the expr in pixels.
dt&lt;&lt;Set Row States(matrix)
Assigns row states to each row of a data table. matrix contains the codes corresponding to
the desired state and contains one entry per row.
dt&lt;&lt;Set Scroll Lock Columns(&quot;name&quot;, ...)
Locks scrolling for the specified columns. If no columns are listed, unlocks scrolling.
dt&lt;&lt;Set Table Variable(&quot;name&quot;, value)
See “dt&lt;&lt;New Table Variable(ʺnameʺ, value)” on page 293.
dt&lt;&lt;Sort(By(columns), order(&quot;Descending&quot; or &quot;Ascending&quot;), Output
Table Name(&quot;name&quot;))
Creates a new table (&quot;name&quot;) by rearranging the rows of dt according to the values of one
or more columns.
dt&lt;&lt;Split(Split(columns), Group(gcol), Col ID(idcol), Remaining
Columns(choice), Output Table Name(&quot;name&quot;))
Creates a new table (&quot;name&quot;) by breaking one or more columns from dt into several.
dt&lt;&lt;Stack(Stack(columns), ID(columns), Stacked(newcol), Output Table
Name(&quot;name&quot;))
Creates a new table (&quot;name&quot;) by combining the values from several columns in dt into one
column newcol.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
297
dt&lt;&lt;Subscribe( &quot;keyname&quot;(&lt;&quot;client&quot;&gt;), On Delete Columns | On Add
Columns | On Add Rows | On Delete Rows | On Rename Column | On Close
| On Save | On Rename ( function ) )
Subscribes to a data table to get messages regarding changes in the data table.
dt&lt;&lt;Subset(Columns(columns), Rows(matrix), Linked, Table
Name(&quot;name&quot;), Copy Formula(1|0), Suppress Formula Evaluation(1|0),
Sampling Rate(rate))
Creates a new table (&quot;name&quot;) from the rows that you specify in dt.
dt&lt;&lt;Summary(Group(col), Subgroup(col), statistic(col))
Creates a new table of summary statistics for the col that you specify, according to
groups and subgroups.
dt&lt;&lt;Suppress Formula Eval(Boolean)
Turns off automatic calculation of formulas for data table dt.
dt&lt;&lt;Transpose(Columns(columns), Rows(matrix), Output Table
Name(&quot;name&quot;))
Creates a new table (&quot;name&quot;) from the rows and columns that you specify.
dt&lt;&lt;Ungroup Columns({col1, col1, ...})
Ungroups the columns defined in the list argument.
dt&lt;&lt;Unsubscribe(&quot;keyname&quot;, On Delete Columns | On Add Columns | On
Add Rows | On Delete Rows | On Close | On Col Rename | All)
Releases any previous subscriptions to the data table.
Columns
col&lt;&lt;Add Column Properties (&quot;name&quot;, expression)
Adds the property &quot;name&quot; with the expression given. You can add any standard column
property by name or a user‐specified property.
col&lt;&lt;Add From Row States
Updates a row state column with any currently used row state changes that are not the
default state.
298
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
col&lt;&lt;Add To Row States
Copies all row state values in a column that are not the default state to the currently used
row state in the data table.
col&lt;&lt;Color Cells(&quot;color&quot;)
Colors the cells of the column within the data table grid. Use any quoted named color or 0
to clear the color.
col&lt;&lt;Color Cell by Value(Boolean)
Colors the cells of the column in the data table grid using the value color property.
col&lt;&lt;Copy Column Properties
Copies the column properties into the buffer.
col&lt;&lt;Copy From Row States
Copies all row state values currently used in the data table to a column.
col&lt;&lt;Copy to Row States
Copies all row state values in the column to the currently used row state in the data table.
col&lt;&lt;Data Type(&quot;type&quot;)
Sets the &quot;type&quot; for col; choices are &quot;Numeric&quot;, &quot;Character&quot;, &quot;Rowstate&quot;.
col&lt;&lt;Delete Formula
Delete the formula from a column.
col&lt;&lt;Delete Property(name)
col&lt;&lt;Delete Column Property(name)
Delete the property name from a column.
col&lt;&lt;Eval Formula
Forces the formula to evaluate (perhaps again).
col&lt;&lt;Exclude(0|1)
Turns the excluded or unexcluded state on, depending on the Boolean argument.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
299
col&lt;&lt;Format(&quot;format&quot;, &lt;width&gt;, &lt;decimal&gt;, &lt;&quot;Use Thousands
Separator&quot;&gt;)
Sets the numeric display format specified.
col&lt;&lt;Formula(expression)
Sets the formula for the variable and evaluates it.
col&lt;&lt;Get Column Field Width
Returns the field width used for displaying data in the column.
col&lt;&lt;Get Data Type
Returns the data type of col.
col&lt;&lt;Get Format
Returns the format of the column.
col&lt;&lt;Get Formula
Returns the formula.
col&lt;&lt;Get Input Format
Returns the format used for input and storing of data for the column.
col&lt;&lt;Get List Check
Returns the list check definition. If list check is not defined for the column, a message is sent
to the log stating so.
col&lt;&lt;Get Lock
Returns the current Lock setting.
col&lt;&lt;Get Modeling Type
Returns the modeling type of the column (&quot;Continuous&quot; or &quot;Ordinal&quot; or &quot;Nominal&quot;).
col&lt;&lt;Get Name
Returns the name of the column.
300
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
col&lt;&lt;Get Property
Returns the specified property definition. If the specified property is not defined for the
column, a message is sent to the log stating so.
col&lt;&lt;Get Range Check
Returns the range check definition. If range check is not defined for the column, a message
is sent to the log stating so.
col&lt;&lt;Get Role
Returns the preselected role of col.
col&lt;&lt;Get Script
Returns the script to reproduce the column.
col&lt;&lt;Get Selected
Returns 1 if the column is selected, or 0 otherwise.
col&lt;&lt;Get Value Labels
Returns the value labels definition. If value labels is not defined for the column, a message
is sent to the log stating so.
col&lt;&lt;Get Use Value Labels
Returns 1 if the value labels are set to be used for the column, or 0 otherwise.
col&lt;&lt;Get Values
Returns the values in the column.
col&lt;&lt;Hide(Boolean)
Turns the Hide attribute on or off according to the Boolean argument given.
col&lt;&lt;Input Format(&quot;format&quot;)
Sets the format used for input and storage for the column. The argument is the name of any
JMP format (for example, &quot;ddmmyyyy&quot; for a date column).
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
301
date_col&lt;&lt;Is Transformed On SAS Export
Returns true if the data in the resulting SAS data set for the date column will be changed
when it is exported to SAS.
col&lt;&lt;Label(Boolean)
Turns the Label attribute on or off according to the Boolean argument given.
col&lt;&lt;Lock(Boolean)
col&lt;&lt;Set Lock(Boolean)
Turns the Lock attribute on or off according to the Boolean argument given.
col&lt;&lt;Preselect Role(&quot;role&quot;)
Preselects the role for the column. Choices are &quot;Y&quot;, &quot;X&quot;, &quot;Weight&quot;, &quot;Freq&quot;, and &quot;None&quot;, or
&quot;No Role&quot;.
col&lt;&lt;Set Scroll Locked(Boolean)
Turns the Scroll Lock attribute on or off according to the Boolean argument given.
col&lt;&lt;Set Display Width(n)
Sets the column display width to the n in pixels.
col&lt;&lt;Set Each Value(n)
Sets all the values in the column to n.
col&lt;&lt;Set Field Width(n)
Sets the field width for the column to n.
col&lt;&lt;Set Modeling Type(&quot;type&quot;)
Sets the modeling type for the variable. Choices are &quot;Continuous&quot;, &quot;Ordinal&quot;, or
&quot;Nominal&quot;.
col&lt;&lt;Set Name(&quot;name&quot;)
Sets the name for the column.
302
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
col&lt;&lt;Set Property (&quot;name&quot;, {argument list})
Sets the property &quot;name&quot; to the expression given. You can set any standard column
property by name or a user‐specified property.
col&lt;&lt;Set Selected(Boolean)
Sets the column to be selected (true or 1) or not selected (false or 0).
col&lt;&lt;Set Values([matrix] or {list})
col&lt;&lt;Values([matrix] or {list})
Sets values for the matrix (for numeric variables) or list (for character variables).
col&lt;&lt;Suppress Eval(Boolean)
Turns off automatic calculation of formulas for the column.
Rows
row&lt;&lt;Colors(n)
Assigns the color n to the selected rows.
row&lt;&lt;Exclude(0|1)
row&lt;&lt;Unexclude(0|1)
Turns the excluded or unexcluded state on for the selected rows according to the Boolean
argument given. Omit the argument to toggle the row state.
row&lt;&lt;Hide(0|1)
row&lt;&lt;Unhide(0|1)
Turns the Hide attribute on or off according to the Boolean argument given. Omit the
argument to toggle the row state.
row&lt;&lt;Label(0|1)
row&lt;&lt;Unlabel(0|1)
Turns the Label attribute on or off according to the Boolean argument given. Omit the
argument to toggle the row state.
Chapter 3
JSL Syntax Reference
JSL Messages
Data Tables
row&lt;&lt;Markers(&quot;marker&quot;)
Assigns the &quot;marker&quot; to the selected rows.
row&lt;&lt;Next Selected
Causes the next selected row in the data table to blink.
row&lt;&lt;Previous Selected
Causes the previous selected row in the data table to blink.
row&lt;&lt;Row Editor
Opens the Row Editor window for the selected rows.
Data Filter
dtf&lt;&lt;Add Filter(columns(column &lt;,col&gt;), &lt;Where(clause)&gt;)
Add one or more filter columns in a new OR group.
dtf&lt;&lt;Auto Clear(0|1)
Clears all currently selected rows before setting a new selection.
dtf&lt;&lt;Clear
Clears the currently selected rows.
dtf&lt;&lt;Close
Closes the data filter window.
dtf&lt;&lt;Columns(col1, col2, ...)
Sets the columns to use in the data filter.
dtf&lt;&lt;Data Table Window
Shows the data table that the data filter window is using.
dtf&lt;&lt;Delete All
Removes all filters that are set.
303
304
JSL Messages
Data Tables
Chapter 3
JSL Syntax Reference
dtf&lt;&lt;Delete(col1, col2, ...
Removes the specified columns from the data filter.
dtf&lt;&lt;Display(col, &lt;Size(x, y)&gt;, &quot;Blocks Display&quot;|&quot;List
Display&quot;|&quot;Single Category Display&quot;|&quot;Checkbox Display&quot;)
Sets how the specified categorical column levels are displayed in the filter. The specified
column must be categorical.
dtf&lt;&lt;Get Script
Returns the script from the local data filter in a string.
dtf&lt;&lt;Local Data Filter
Embeds the data filter in the specified window.
dtf&lt;&lt;Location(x, y)
Moves the data filter window to the specified location. X and y are measured in pixels. 0,0
is the top left of the monitor.
dtf&lt;&lt;Make Subset
Creates a new subset data table that contains the rows that are selected in the data filter.
dtf&lt;&lt;Match(Filter Columns(:col1, :col2, ...), Where(WHERE clause)
Sets the filter conditions for each column. The WHERE clause is used for all the columns
listed. To use different WHERE clauses for different columns, send the Match message
separately for each column.
dtf&lt;&lt;Mode(Select(0|1)|Show(0|1)|Include(0|1))
Sets the action, or mode, that is used when rows are selected using the data filter.
dtf&lt;&lt;Save and restore current row states
Saves the current row states for the data table, and then restores those states when the data
filter is closed.
dtf&lt;&lt;Show Columns Selector(0|1)
Displays or hides the column selector after completing a filter.
Chapter 3
JSL Syntax Reference
JSL Messages
Databases
305
dtf&lt;&lt;to Clipboard
Creates a WHERE clause from the current state of the data filter and places it on the
clipboard, where it can be pasted elsewhere.
dtf&lt;&lt;to Data Table
Creates a WHERE clause from the current state of the data filter and saves it as a property
to the data table.
dtf&lt;&lt;to Journal
Creates a WHERE clause from the current state of the data filter and appends it to the
current journal. If there is no current journal, a new journal is opened and the WHERE
clause is added to it.
dtf&lt;&lt;to Row State Column
Creates a row state column whose formula is the WHERE clause.
dtf&lt;&lt;to Script Window
Creates a WHERE clause from the current state of the data filter and appends it to the
current script window. If there is no current script window, a new script window is opened
and the WHERE clause is added to it.
dtf&lt;&lt;Use Floating Window(0|1)
Sets whether the data filter window floats on top of its associated data table or behaves as a
normal window.
dtf&lt;&lt;Where(WHERE clause)
Sets a condition for selecting rows.
Databases
dt&lt;&lt;Save Database(&quot;connectInfo&quot;, &quot;TableName&quot;)
Saves a data table to a database.
306
JSL Messages
Datafeed
Chapter 3
JSL Syntax Reference
Datafeed
feed&lt;&lt;Close
Closes the Datafeed object and its window.
feed&lt;&lt;Connect(portSettings)
(Windows only) Sets up port settings for the connection to the device.
feed&lt;&lt;Disconnect
(Windows only) Disconnects the device from the Datafeed queue but leaves the Datafeed
object active.
feed&lt;&lt;Get Line
Returns and removes one line from the Datafeed queue.
feed&lt;&lt;Get Lines
Returns as a list and removes all lines from the Datafeed queue.
feed&lt;&lt;Queue Line(string)
Sends one line to the end of the Datafeed queue.
feed&lt;&lt;Restart
Restarts processing queued lines.
feed&lt;&lt;Set Script(script)
Assigns the script that is run each time a line of data is received.
feed&lt;&lt;Stop
Stops processing queued lines.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
307
Display Boxes
All Display Boxes
db&lt;&lt;Add Text Annotation(Text(&quot;string&quot;), Text Box(x1, y1, x2, y2))
Draws a text annotation box that contains the string. The Text Box argument controls where
the text annotation box is drawn in relation to the display box, from the upper left corner to
the lower right corner.
db&lt;&lt;Append(db2)
Add db2 to the display tree after db.
db&lt;&lt;Child
Returns the child of the box.
db&lt;&lt;Class Name
Returns the name of the display class for the box.
db&lt;&lt;Clone Box
Makes a new copy of the display box.
db&lt;&lt;Close Window
Closes the containing window.
db&lt;&lt;Copy Picture
Puts a picture of the box on the clipboard.
db&lt;&lt;Delete
Delete the display box
db&lt;&lt;Get HTML
Returns a string containing HTML source for the box.
db&lt;&lt;Get Journal
Returns a string containing journal source for the box.
308
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
db&lt;&lt;Get Menu Item State(index)
Returns the popup menu item state of the index menu item. The state can be normal (0),
checked (1), or disabled (‐1).
db&lt;&lt;Get Menu Items
Returns the menu items used for popup menu when the button is clicked. For submenus
see &lt;&lt;Get Submenu(index).
db&lt;&lt;Get Menu Script
Returns the menu script attached to the calling object.
db&lt;&lt;Get Page Setup()
Returns the page setup settings.
Example
The example below creates a new window and returns the page setup configuration.
w = New Window( &quot;Window&quot;,
Text Box( &quot;Page Setup Test&quot; )
);
w &lt;&lt; get page setup();
The results of the message:
{Margins( {0.75, 0.75, 0.75, 0.75} ), Scale( 1 ), Portrait( 1 ),
Paper Size( &quot;Letter&quot; )}
db&lt;&lt;Get Picture
Captures db as a Picture Object.
db&lt;&lt;Get RTF
Returns a string containing RTF source for the box.
db&lt;&lt;Get Script
Returns the script for recreating the display box.
db&lt;&lt;Get Size
Returns either { x, y } or { h, v } in pixels:
xy = DisplayBox &lt;&lt; Get Size;
Returns x and y in pixels:
{ x, y } = DisplayBox &lt;&lt; Get Size;
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
309
db&lt;&lt;Get Submenu (index)
Returns the number of submenu items under the given menu item.
Example
The example below creates a menu containing “A”, “B”, and “C” with “A” having a
submenu “A1” and “A2” and “B” having a submenu “B1”, “B2”, and “B3”. &lt;&lt;Get
Submenu(inc) returns the number of submenu items under each indexed menu item.
New Window( &quot;Title&quot;, obj = Outline Box( &quot;title&quot; ) );
submenus = { };
obj &lt;&lt; Set Menu Script(
{&quot;A&quot;, &quot;&quot;, &quot;A1&quot;, Print( &quot;A1&quot; ), &quot;A2&quot;, Print( &quot;A2&quot; ),
&quot;B&quot;, &quot;&quot;, &quot;B1&quot;, Print( &quot;B1&quot; ), &quot;B2&quot;, Print( &quot;B2&quot; ), &quot;B3&quot;, Print( &quot;B3&quot; ),
&quot;C&quot;, Print( &quot;C&quot; )}
);
obj &lt;&lt; Set Submenu(1, 2); // menu A with 2 items in submenu A1 and A2
obj &lt;&lt; Set Submenu(4, 3); // menu B with 3 items in submenu B1, B2, and B3
For( inc = 1, inc &lt;= N Items( Words( obj &lt;&lt; Get Menu Script, &quot;,&quot; ) ), inc++,
Insert Into( submenus, obj &lt;&lt; Get Submenu(inc) );
);
submenus;
{2, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
The log output indicates that index(1) contains two submenu items and index(3)
contains three submenu items.
db&lt;&lt;Get Text
Returns a string containing the text of the box.
db&lt;&lt;Inval
Invalidates the display box area in the window. The window is updated the next time the
operating system has an opportunity to update windows (for example, when the user
resizes the display box).
Notes
Consider including the new message &lt;&lt;Update Window rather than including Wait(0). The
problem with using Wait(n) is knowing how large n should be.
Many display box messages, such as &lt;&lt;Set Text, automatically mark the box as invalid, so
the &lt;&lt;Inval message is usually unnecessary. Some interactive scripts that use sliders with
JSL callbacks may need &lt;&lt;Update Window to keep various parts of the display synchronized
with the slider.
db&lt;&lt;Journal
Appends the box to the journal.
310
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
db&lt;&lt;Journal Window
Appends the containing window of the display box to the journal; compare with Journal.
db&lt;&lt;Move Window(x, y)
Moves the window to the (x,y) location on your screen.
db&lt;&lt;Page Break
Inserts a page break before the box.
db&lt;&lt;Parent
Returns the parent of this display box.
db&lt;&lt;Prepend(db2)
Add db2 to the display tree before db.
db&lt;&lt;Reshow
Invalidates the display box’s area in the window and immediate removes invalid areas
from the window.
db&lt;&lt;Save Capture(&quot;path&quot;, &lt;&quot;format&quot;&gt;, &lt;Add Sibling(n)&gt;)
Saves the display box as a graphic to the specified ʺpathʺ in the specified ʺformatʺ. The
optional Add Sibling argument adds the number of sibling display boxes to include in the
capture. The default value is 1, which captures only the specified display box. Note that the
specified portion of the report is not guaranteed to be scrolled into view or unobstructed by
other windows. If the display box is not visible, the saved graphic will not contain the
contents that you expect.
db&lt;&lt;Save HTML(&quot;&quot; | &quot;path&quot;, &quot;format&quot;)
Saves HTML source and folder of graphics in ʺformatʺ specified.
db&lt;&lt;Save Interactive HTML( &quot;path&quot; )
Saves the display box as a web page that includes interactive HTML 5 features. Non‐JMP
users can then explore the data.
Examples
biv = Bivariate( y( weight ), x( height ));
rbiv = (biv &lt;&lt; report);
rbiv &lt;&lt; Save Interactive HTML( &quot;f:\MyInteractiveHTML.htm&quot;);
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
311
To include By groups, follow this example:
biv = Bivariate( y( weight ), x( height ));
Current Report() &lt;&lt; Save Interactive HTML( &quot;f:\MyInteractiveHTML.htm&quot;);
db&lt;&lt;Save Journal(&quot;&quot; | &quot;path&quot;)
Saves journal source for the box.
db&lt;&lt;Save MSWord(&quot;pathname&quot;, Native)
Saves the display box as a Microsoft Word document. (Windows Only)
db&lt;&lt;Save Picture(&quot;&quot; | &quot;pathname&quot;, &quot;format&quot;)
Saves a picture of the box.
Notes
On Windows, the Windows Specific preferences determine the resolution (or DPI), or you
can run the following script:
Pref( Save Image DPI( &lt;number&gt; ) );
On Macintosh, the operating system determines the DPI.
db&lt;&lt;Save Presentation(&quot;path&quot;, &lt;template(&quot;path&quot;)&gt;,
&lt;(Insert(&quot;Begin&quot;|&quot;End&quot;|N) | Replace(&quot;Begin&quot;|&quot;End&quot;|N) | &quot;Append&quot;)&gt;,
&lt;Outline
Titles(&quot;None&quot;|&quot;Hide&quot;|&quot;TopLeft&quot;|&quot;TopRight&quot;|&quot;BottomLeft&quot;|&quot;BottomRight&quot;
)&gt;, &lt;format&gt;)
Saves display boxes in a Microsoft PowerPoint presentation. You can open the file in any
presentation software program.
Arguments
path The quoted location of the saved file. You must include the .pptx extension in the
filename. An existing file with the same name is overwritten.
template Optional. The quoted path name and file name of a custom PowerPoint
template. Without this argument, JMP uses the default template located in the pptx
folder of the installation directory.
Include a simple table in your template, or a default table format is applied to report
tables. For an example on Windows, see /pptx/JMPExportTemplate.pptx in the JMP
installation folder.
Insert Optional. Determines where the slides are inserted in an existing presentation.
‒ n inserts the slides as the nth slide number.
‒ ʺBegin ʺinserts the slides at the beginning of the presentation.
312
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
‒ ʺEndʺ inserts the slides at the end of the presentation.
Replace Optional. Determines which slides are replaced in an existing presentation. The
arguments are n, ʺBeginʺ, and ʺEndʺ as described for Insert.
Append Optional. The slides are inserted at the end of an existing presentation.
Outline Titles Optional. The location of the outline titles on the slide. By default,
outline titles appear in the bottom left corner of the slide.
‒ ʺNoneʺ omits the slide title above the graphic and the outline titles.
‒ ʺHideʺ omits the outline titles.
‒ ʺTopLeftʺ, ʺTopRightʺ, ʺBottomLeftʺ, ʺBottomRightʺ determine the position of the
outline titles on the slide. The outline title and its parent titles are included.
format Optional. The quoted format of the embedded graphics. Options are &quot;Native&quot;,
&quot;EMF&quot;, &quot;PNG&quot;, &quot;JPG&quot;, &quot;BMP&quot;, &quot;GIF&quot;, &quot;TIF&quot;. On Windows, the native format is EMF. On
Macintosh, the native format is PDF. See “Notes” for compatibility issues. Without this
argument, JMP applies the “Image Format for PowerPoint” General preference.
Notes
Windows does not support the native PDF graphics produced on Macintosh. Macintosh
does not support the native EMF graphics produced on Windows. For cross‐platform
compatibility, specify &quot;PNG&quot;, &quot;JPG&quot;, &quot;GIF&quot;, or &quot;TIF&quot;.
db&lt;&lt;Save RTF(&quot;&quot; | &quot;pathname&quot;, &quot;format&quot;)
Saves RTF source with graphics in ʺformatʺ specified.
db&lt;&lt;Save Text(&quot;&quot; | &quot;pathname&quot;, &quot;format&quot;)
Saves a file containing the text of the box.
db&lt;&lt;Scroll Window(x, y)
Scrolls the containing window.
db&lt;&lt;Select
db&lt;&lt;Deselect
Selects (highlights) or deselects the box.
db&lt;&lt;Set Menu Item State(index, 0 | 1 | -1)
Sets the popup menu item at index to be normal (0), checked (1), or disabled (‐1).
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
313
db&lt;&lt;Set Page Setup&lt;margins(left, right, top, bottom)&gt;,
&lt;scale(s)&gt;,&lt;portrait(Boolean)&gt;, &lt;paper size(&quot;paper&quot;))
db&lt;&lt;Set Page Setup&lt;margins({left, right, top, bottom})&gt;,
&lt;scale(s)&gt;,&lt;portrait(Boolean)&gt;, &lt;paper size(&quot;paper&quot;))
Sets the page settings. Margins are set in inches. Scale variable s is a number in the range of
10 (for 1000%) to 0.2 (for 20%) with the default as 1 (for 100%). If portrait is True the page is
oriented for portrait, otherwise the page is landscape. Paper size is a string specifying the
paper size, for example, ʺLetterʺ or ʺLegalʺ.
Example
The example below creates a new window and configures the page setup.
w = New Window( &quot;Window&quot;,
Text Box( &quot;Page Setup Test&quot; )
);
w &lt;&lt; Set page setup(
margins( 1, 1, 1, 1 ),
scale( 1 ),
portrait( 1 ),
paper size( &quot;Letter&quot; )
);
db&lt;&lt;Set Submenu (index, submenu count)
Sets the submenu items for the item (specified by index number) by specifying the number
of items in the submenu.
Example
The example below creates a menu containing “A”, “B”, and “C” with “A” having a
submenu “A1” and “A2” and “B” having a submenu “B1”, “B2”, and “B3”.
New Window( &quot;title&quot;, ob = Outline Box( &quot;title&quot; ) );
submenus = { };
ob &lt;&lt; Set Menu Script(
{&quot;A&quot;, &quot;&quot;, &quot;A1&quot;, Print( &quot;A1&quot; ), &quot;A2&quot;, Print( &quot;A2&quot; ),
&quot;B&quot;, &quot;&quot;, &quot;B1&quot;, Print( &quot;B1&quot; ), &quot;B2&quot;, Print( &quot;B2&quot; ), &quot;B3&quot;, Print( &quot;B3&quot; ),
&quot;C&quot;, Print( &quot;C&quot; )}
);
ob &lt;&lt; set submenu(1, 2); // menu A with 2 items in submenu A1 and A2
ob &lt;&lt; set submenu(4, 3); // menu B with 3 items in submenu B1, B2, and B3
db&lt;&lt;Set Report Title(&quot;title&quot;)
Sets a new title.
314
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
Show Properties(db)
Shows the messages a given display box can interpret.
db&lt;&lt;Sib
Returns the sibling of the box.
db&lt;&lt;Sib Append(db2)
Appends a display as a sibling to this one. The argument must evaluate to a display box
owner or reference.
db&lt;&lt;Size Window(x, y)
Resizes the containing window.
db&lt;&lt;Update Window
Updates the window that holds the display box (and possibly other windows as well,
depending on the operating system) if there are invalidated regions. Previously invalidated
box areas are redrawn with their new content.
Notes
In some interactive JSL scripts that combine sliders with JSL callbacks, you might need to
use &lt;&lt;Update Window to keep parts of the display synchronized with the slider.
db&lt;&lt;Zoom Window
Resizes the window to be large enough to show all of its contents.
Axis Boxes
axis box&lt;&lt;Axis Settings(&lt;named_arguments&gt;)
Opens the axis specification window or specifies axis settings such as tick marks and axis
labels.
If no arguments are included, the axis specification window appears.
Otherwise, specify named arguments for each axis.
‒ Specify the Y axis as axis box(1).
‒ Specify the X axis as axis box(2).
The following example creates a bivariate plot and defines settings for the X and Y axes.
Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
biv = Bivariate( X( :height ), Y( :weight ), FitLine );
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
315
rbiv = biv &lt;&lt; report;
xaxis = rbiv[axis box( 2 )];
yaxis = rbiv[axis box( 1 )];
xaxis &lt;&lt; Axis Settings( Show Major Grid( 1 ) );
yaxis &lt;&lt; Axis Settings( Decimal( 10, 3 ) );
axis box&lt;&lt;Add Axis Label(&quot;string&quot;)
Adds an axis label with the specified string.
axis box&lt;&lt;Add Ref Line(number, &quot;linestyle&quot;, &lt;&quot;color&quot;&gt;, &lt;&quot;label&quot;&gt;,
&lt;width&gt;)
Adds a reference line at number in the linestyle (&quot;Solid&quot; | &quot;Dashed&quot; | &quot;Double&quot;),
&quot;color&quot; (using &quot;color name&quot; or index number), ʺlabelʺ, and width (in pixels) specified.
Note: When a reference line is added that uses the same ʺlabelʺ as an existing reference
line, the existing reference line is removed and the new line added.
axis box&lt;&lt;Decimal(width, decimalplaces)
Changes the numeric format for axis values.
axis box&lt;&lt;Format(&quot;name&quot;)
Changes to the numeric format given by &quot;name&quot;.
axis box&lt;&lt;Inc(n)
Sets the increment between ticks.
axis box&lt;&lt;Interval(&quot;format&quot;)
Specifies the units used for Inc() with date/time formats: &quot;Numeric&quot;, &quot;Year&quot;, &quot;Quarter&quot;,
&quot;Month&quot;, &quot;Week&quot;, &quot;Day&quot;, &quot;Hour&quot;, &quot;Minute&quot;, or &quot;Second&quot;.
axis box&lt;&lt;Label Orientation(&quot;format&quot;)
Description
Rotates the axis label to one of the following quoted formats: &quot;Automatic&quot; (based on the
width of the label), &quot;Horizonal&quot;, &quot;Vertical&quot;, &quot;Perpendicular&quot;, &quot;Parallel&quot;, and
&quot;Angled&quot;.
axis box&lt;&lt;Major Grid Line Color(&quot;color&quot;)
Sets the color for the major grid (if enabled) using either the &quot;color name&quot; or index
number.
316
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
axis box&lt;&lt;Max(max)
Changes the maximum value on the axis.
axis box&lt;&lt;Minor Grid Line Color(&quot;color&quot;)
Sets the color for the minor grid (if enabled) using either the &quot;color name&quot; or index
number.
axis box&lt;&lt;Min(min)
Changes the minimum value on the axis.
axis box&lt;&lt;Minor Ticks(number)
Specifies the number of minor tick marks between major tick marks.
axis box&lt;&lt;Remove Axis Label
Removes any label added with Add Axis Label.
axis box&lt;&lt;Reverse Scale(Boolean)
Reverses the normal scale direction so that the highest value is on the left or bottom (that is,
closest to the origin).
axis box&lt;&lt;Revert Axis
Restores the axis’ original settings (from time of creation).
axis box&lt;&lt;Scale(&quot;type&quot;)
Changes the scale of the axis to type (&quot;Linear&quot; | &quot;Log&quot; | &quot;Exp Prob&quot;| &quot;Weibull Prob&quot;
| &quot;Logistic Prob&quot; | &quot;Frechet Prob&quot; | &quot;Normal&quot; | &quot;Cube Root&quot; |
&quot;Johnson Su Scale&quot; | &quot;Geodesic&quot; | &quot;Geodesic US&quot; | &quot;Custom Scale&quot; | &quot;Power&quot;).
If the type is Custom Scale, this message expects two additional clauses: Scale to
Internal(expr) and Scale to External(expr).
axis box&lt;&lt;Tick Font(&quot;name&quot;, &lt;size&gt;, &lt;&quot;style&quot; | &quot;style style...&quot;&gt;,
&quot;&lt;angle&gt;&quot;)
Sets the font name and properties for tick marks. To specify more than one style, include a
space between each style and place them in quotes.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
317
axis box&lt;&lt;Show Labels(Boolean)
Shows or hides labels for the axis values.
axis box&lt;&lt;Show Major Grid(Boolean)
Adds or removes grid lines at the major tick values.
axis box&lt;&lt;Show Major Ticks(Boolean)
Shows or hides major tick marks.
axis box&lt;&lt;Show Minor Grid(Boolean)
Adds or removes grid lines at the minor tick values.
axis box&lt;&lt;Show Minor Ticks(Boolean)
Shows or hides minor tick marks.
axis box&lt;&lt;Tick Label List(&lt;i&gt;, {&quot;text1&quot;,&quot;text2&quot;, ...},{n1, n2, ...})
Sets the values and positions of the axis tick labels.
The first (optional) integer, i, is the label row index. Leaving it out clears any existing label
rows and creates one new one as specified. Including it allows you to override any
particular label row; using an index higher than the current number of label rows adds a
new label row on to the end.
The second list argument is the string titles for your labels.
The third list argument is optional and specifies the values corresponding to each label; if
the value list is omitted, the labels will be on integer increments starting with 1.
Border Boxes
border box&lt;&lt;Set Background Color( {R, G, B} | &lt;&quot;color&quot;&gt;)
Sets the background color for a border box. Specify a ʺcolor nameʺ or a list of RGB values.
For example:
border box&lt;&lt;set background color(&quot;red&quot;);
or
border box&lt;&lt;set background color( {255, 192, 3} );
318
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
border box&lt;&lt;Set Color( {R, G, B} | &lt;&quot;color&quot;&gt;)
Sets the border color for a border box. Specify a ʺcolor nameʺ or a list of RGB values. For
example:
border box&lt;&lt;set color(&quot;red&quot;);
border box&lt;&lt;Get Color
Gets the border color for a border box.
border box&lt;&lt;Set Style (&quot;style&quot;)
Sets the border style for a border box. Specify the style as one of the following numbers or
keywords: 0 (&quot;Solid&quot;), 1 (&quot;Dotted&quot;), 2 (&quot;Dashed&quot;), 3 (&quot;DashDot&quot;), or 4 (&quot;DashDotDot&quot;). For
example:
border box&lt;&lt;Set Style(&quot;dotted&quot;);
border box&lt;&lt;Get Style
Gets the border style for a border box. For example:
border box&lt;&lt;Get Style;
Data Grid Boxes
dgb&lt;&lt;Set Data Table(&lt;data_table&gt;)
Sets the data table for the data grid box.
Frame Boxes
frame box&lt;&lt;Add Graphics Script(&lt;order&gt;,&lt;&quot;description&quot;&gt;, &lt;script&gt;)
Description
Adds a script to draw graphics in the frame box.
Arguments
order An optional argument that specifies the order in which the graphics elements are
drawn. The value can be the keyword Back or Forward or an integer that specifies the
drawing order for a number of graphics elements. 1 means the object is drawn first.
description An optional string that appears in the Customize Graph window next to the
graphics script.
script An optional JSL script.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
319
Example
In the following example, the graphics script draws the line first and then draws the other
graphics elements: the grid lines, references lines, and markers that create the bivariate
plot. Without the 1 order argument, the line is drawn last and covers up the markers.
dt = Open( &quot;$SAMPLE_DATA/Big Class.jmp&quot; );
obj = Bivariate( Y( :weight ), X( :height ) );
Report( obj )[FrameBox( 1 )] &lt;&lt;
Add Graphics Script(
1, // draws the line first
Description( &quot;Pen Script&quot; ),
Pen Color( &quot;red&quot; );
Pen Size( 5 );
Y Function( 60 + 120 / 2 * (1 + Sine( (2 * Pi() * (x - 50)) / 22.5 )), x );
);
frame box&lt;&lt;Append Seg
Adds a display seg to the specified Frame Box.
frame box&lt;&lt;Background Color( {R, G, B} | &lt;&quot;color&quot;&gt;)
Changes the background color. Specify a ʺcolor nameʺ or a list of RGB values.
frame box&lt;&lt;Child Seg
Returns the display seg child of the Frame Box.
frame box&lt;&lt;Edit Graphics Script
Brings up a dialog box to view, edit, or delete the current graphics scripts.
frame box&lt;&lt;Find Seg
Returns a display seg with the specified argument (for example, the name of a seg).
frame box&lt;&lt;Frame Size(x, y)
Resets the size of the frame, in pixel units.
frame box&lt;&lt;Marker Size(size)
Changes the marker size.
320
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
frame box&lt;&lt;Row Colors(color)
frame box&lt;&lt;Row Markers(marker)
frame box&lt;&lt;Row Exclude
frame box&lt;&lt;Row Hide
frame box&lt;&lt;Row Label
Forwards commands to the data table associated with the report, so that the row states of
selected rows can be manipulated. For &lt;&lt;Row Exclude, &lt;&lt;Row Hide, and &lt;&lt;Row Label,
omitting the argument toggles the option. If the option is off, the message turns it on. If the
option is on, the message turns it off.
frame box&lt;&lt;X Axis(min, max, inc, named arguments)
Scales the X coordinate system.
frame box&lt;&lt;Y Axis(min, max, inc, named arguments)
Scales the Y coordinate system.
Matrix Boxes
matrix box&lt;&lt;Get
Returns the matrix contents.
matrix box&lt;&lt;Make Into Data Table(&lt;Invisible(Boolean)&gt;)
Turns the matrix into a new data table. The optional argument Invisible(), if True, hides
the data table from view but shows it in the Window List pane. If False, the Invisible()
argument shows the data table and it is listed in the Window List pane.
matrix box&lt;&lt;Set Format(width, decimalplaces)
Sets the numeric format for matrix elements.
matrix box&lt;&lt;Sort(column_num, ascending_bool)
Sorts the rows of the matrix based on the column number specified by column_num. The
default sort order is ascending.
If column_num is 0, the sort is removed.
If ascending_bool is ʺTrue&quot;, the sort is performed in ascending order. If ascending_bool is
ʺFalse&quot;, the sort is in descending order.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
321
Nom Axis Boxes
nom axis box&lt;&lt;Divider Lines(Boolean)
Adds or removes divider lines between labels in the axis box.
nom axis box&lt;&lt;Lower Frame(Boolean)
Adds or removes a lower frame around the axis.
nom axis box&lt;&lt;Rotated Tick Labels(Boolean)
Rotates or unrotates the labels at each tick value.
Number Col Boxes
number col box&lt;&lt;Add Element(item)
Adds the item to the Number Col Box. Item can be a single number, a list of numbers, or a
matrix of numbers.
number col box&lt;&lt;Get
number col box&lt;&lt;Get(i)
Gets the values in a list, or the i th value.
number col box&lt;&lt;Get As Matrix
Gets the values in a matrix, specifically a column vector.
number col box&lt;&lt;Get Format
Returns the current format (width, decimalplaces). A decimalplaces &gt; 100 indicates
date/time values.
number col box&lt;&lt;Get Heading
Returns the column heading text.
322
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
number col box&lt;&lt;Set Format(width, decimalplaces)
number col box&lt;&lt;Set Format(&quot;format&quot;, width)
Sets the format. Set decimalplaces &gt; 100 for date/time values. Set decimalplaces = 97 for
p‐value format.
For example,
&lt;&lt; Set Format( 10, 2)
&lt;&lt; Set Format( &quot;Scientific&quot;, 10 )
number col box&lt;&lt;Set Heading(&quot;string&quot;)
Changes the column heading text.
Outline Boxes
outline box&lt;&lt;Close(Boolean)
Closes the outline box.
outline box&lt;&lt;Close All Below
Closes all the node’s child nodes.
outline box&lt;&lt;Close All Like This
Closes all nodes similar to this outline box.
outline box&lt;&lt;Close Where No Outlines
Closes all nodes that do not have children.
outline box&lt;&lt;Get Title
Gets the title of the outline box.
outline box&lt;&lt;Horizontal(Boolean)
Horizontally aligns the node’s children.
outline box&lt;&lt;Open All Below
Opens all the node’s child nodes.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
323
outline box&lt;&lt;Open All Like This
Opens all nodes similar to this outline box.
outline box&lt;&lt;Set Menu Script({&quot;string1&quot;, script1,&quot;string2&quot;, script2,
...})
Adds an entry to the menu when the red triangle on an outline box is selected.
outline box&lt;&lt;Set Title(&quot;text&quot;)
Changes the title of the outline box.
Panel Boxes
panel box&lt;&lt;Get Title
Gets the title of the panel box.
panel box&lt;&lt;Set Title(&quot;text&quot;)
Changes the title of the panel box.
Plot Col Boxes
plot col box&lt;&lt;Get As Matrix
Gets the values in a matrix, specifically a column vector.
plot col box&lt;&lt;Set Values([matrix] or {list})
Sets values for the matrix (for numeric variables) or list (for character variables).
Slider Boxes and Range Slider Boxes
slider box&lt;&lt;Get(&lt;index&gt;)
range slider box&lt;&lt;Get Lower(&lt;index&gt;)
range slider box&lt;&lt;Get Upper(&lt;index&gt;)
Returns the current floating‐point value of the slider.
324
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
slider box&lt;&lt;Set(n, &lt;index&gt;, &lt;run script(0|1)&gt;)
range slider box&lt;&lt;Set Lower(n, &lt;index&gt;, &lt;run script(0|1)&gt;)
range slider box&lt;&lt;Set Upper(n, &lt;index&gt;, &lt;run script(0|1)&gt;)
Sets the floating‐point value of the slider. run script(0|1) controls whether an on‐change
script runs after the &lt;&lt;Set, &lt;&lt;Set Lower, or &lt;&lt;Set Upper message.
slider box&lt;&lt;Get Min()
Returns the minimum value possible for the range slider and slider.
slider box&lt;&lt;Set Min()
Sets the minimum value possible for the range slider and slider.
slider box&lt;&lt;Get Max()
Returns the maximum value possible for the range slider and slider.
slider box&lt;&lt;Get Var
range slider box&lt;&lt;Get Lower Var
range slider box&lt;&lt;Get Upper Var
Returns the variable name associated with the slider.
slider box&lt;&lt;Set Max()
Sets the maximum value possible for the range slider and slider.
slider box&lt;&lt;Set Script(&lt;script&gt;)
Sets a script to be run when the range sliders and slider is updated.
slider box&lt;&lt;Set Var(slider_var)
range slider box&lt;&lt;Set Lower Var(slider_var)
range slider box&lt;&lt;Set Upper Var(slider_var)
Sets the variable name associated with the slider.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
325
String Col Boxes
string col box&lt;&lt;Add Element(item)
Adds the item to the String Col Box. Item can be a single quoted string, a list of quoted
strings, or a matrix of quoted strings.
string col box&lt;&lt;Get
string col box&lt;&lt;Get(i)
Gets the values in a list, or the i th value.
string col box&lt;&lt;Get Heading
Returns the column heading text.
string col box&lt;&lt;Set Heading(&quot;text&quot;)
Changes the column heading text.
Tab Boxes
tab box&lt;&lt;Get Tab Margin()
Returns a list of the current margins in pixels for the tab box in this order: {left, top,
right, bottom}.
tab box&lt;&lt;Set Style(&quot;tab&quot; | &quot;combo&quot; | &quot;outline&quot; | &quot;vertical spread&quot; |
&quot;horizontal spread&quot; | &quot;minimize size&quot;)
Changes the appearance of the tab box from a tab to a combo box or outline node.
ʺvertical spreadʺ and ʺhorizontal spreadʺ change the orientation of the tab title.
ʺminimize sizeʺ bases the tab style on the width of the tab title. See the Scripting Guide for
an example.
tab box&lt;&lt;Set Tab Margin(n|{...})
Sets the tab margin for the tab box. If a single number is specified, all four margins are set to
that number of pixels. If a list of two numbers is specified, the left and right margins are set
to the first number, and the top and bottom margins are set to the second number. If a list of
four numbers is specified, the margins are set in this order: {left, top, right, bottom}.
326
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
tab box&lt;&lt;Show Tabs(0|1)
Shows or hides the tabs for tab boxes. If you hide the tabs, you need to provide another way
to select and show tabs. For example, a list box that contains a list of references to the tabs.
The default value is 1.
Table Boxes
table box&lt;&lt;Get
Gets the entries of the table in list form.
table box&lt;&lt;Get As Matrix
Gets the numeric entries of the table in matrix form.
table box&lt;&lt;Get Locked Columns
Returns the number of columns that cannot be dragged with the hand cursor or have any
columns dropped before them.
table box&lt;&lt;Get Row Change Function
Returns the expression that is evaluated when a row is selected.
table box&lt;&lt;Get Selectable Rows
Returns True if the table box currently allows row selection.
table box&lt;&lt;Get Selected Row Color
Returns the index number of the background color of the selected rows in the table box.
table box&lt;&lt;Make Combined Data Table
Same as Make Data Table, but also searches the report for report tables with the same
columns and combine all of these into the new data table.
table box&lt;&lt;Make Data Table(name)
Turns the table entries into a new data table.
table box&lt;&lt;Set Row Change Function
Sets the expression that is evaluated when a row is selected.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
table box&lt;&lt;Set Cell Changed Function(Function({this, col box,
row},&lt;script&gt;;))
Sets a function that is called whenever the user edits a cell in a column in a table.
Example
This example prints to the log the old and the new values for the changed cell.
Names Default To Here( 1 );
New Window( &quot;Mountains&quot;,
tb = Table Box(
String Col Edit Box(
&quot;Mountain&quot;,
{&quot;K2&quot;, &quot;Delphi&quot;, &quot;Kilimanjaro&quot;,
&quot;Grand Teton&quot;}
),
Number Col Edit Box(
&quot;Elevation (meters)&quot;,
{8611, 681, 5895, 4199}
),
Plot Col Box( &quot;&quot;, {8611, 681, 5895, 4199} )
)
);
tb &lt;&lt;
Set Cell Changed Function(
Function( {this, col, row},
Print(
(col &lt;&lt; get heading) || &quot;: row:&quot; ||
Char( 3 ) || &quot; is now &quot; ||
Char( col &lt;&lt; get( row ) )
)
)
);
table box&lt;&lt;Set Locked Columns(n)
Locks the first n columns. You cannot drag the locked columns or drag columns before
them.
table box&lt;&lt;Set Selectable Rows(Boolean)
Makes the rows of the Table Box selectable or not.
table box&lt;&lt;Set Selected Row Color(&quot;color&quot;)
If the rows of the Table Box are selectable (Set Selectable Rows(True)), sets the
background color for the selected rows.
327
328
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
Text Boxes
text box&lt;&lt;Font Color(n)
Sets the color for Text strings.
text box&lt;&lt;Get Hidden State
Returns the current state of a text box.
text box&lt;&lt;Get Text
Returns the string content of the box.
text box&lt;&lt;Get Tip
Returns the tooltip for the text box (or a text edit box).
text box&lt;&lt;Markup
Returns text formatted with the specified HTML tags. The HTML must be well‐formed;
make sure you close nested tags correctly.
The following example returns text formatted in bold, italic, and underlined.
w = New Window(&quot;Formatted Text&quot;,
Text Box(&quot;This is &lt;b&gt;bold&lt;/b&gt; text. This is &lt;b&gt;&lt;i&gt;bold italic&lt;/i&gt;&lt;/b&gt; text.
This is &lt;u&gt;underlined&lt;/u&gt; text.&quot;,
&lt;&lt;Markup) );
text box&lt;&lt;Rotate Text(&quot;direction&quot;)
Rotates the text 90 degrees &quot;left&quot; or &quot;right&quot;, or returns it to the horizontal.
text box&lt;&lt;Set Font(&quot;name&quot;, &lt;size&gt;, &lt;style | &quot;style style...&quot;&gt;,
&lt;angle&gt;)
Sets the font name and properties for text strings. To specify more than one style, include a
space between each style and place them in quotes.
text box&lt;&lt;Set Font Size(n)
Sets the font size in points for text strings.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
329
text box&lt;&lt;Set Font Style(&quot;style&quot; | &quot;style style...&quot;)
Sets the font style for text strings. To specify more than one style, include a space between
each style and place them in quotes. Integers are backwards compatible but not
recommended for new scripts.
text box&lt;&lt;Set Script(script)
Associate a script to a text box. The script executes when the user hits enter (or the text edit
box otherwise loses focus).
text box&lt;&lt;Set Text(&quot;string&quot;)
Changes the string content of the box.
text box&lt;&lt;Set Tip(&quot;string&quot;)
Sets the tooltip for the text box (or a text edit box).
text box&lt;&lt;Set Wrap(n)
Set the wrap point, in pixels, in pixels (n).
Windows
window&lt;&lt;Bring Window to Front
Brings the window to the front.
window&lt;&lt;Close Window(&lt;nosave&gt;)
Closes the window. If the optional argument nosave is specified, the window (journal,
project, and so forth) is closed without saving or prompting.
window&lt;&lt;Get Content Size
Returns the size of the window’s contents.
window&lt;&lt;Get Window Icon
Returns the name of the window’s icon.
window&lt;&lt;Get Window Position
Returns the position of the window.
330
JSL Messages
Display Boxes
Chapter 3
JSL Syntax Reference
window&lt;&lt;Get Window Size
Returns the size of the window.
window&lt;&lt;Get Window Title
Returns the title of the window.
window&lt;&lt;Inval
Invalidate the display box. The window updates either when the &lt;&lt;Update Window message
is sent or when the operating system has time for the update. See &lt;&lt;Reshow for another
method.
window&lt;&lt;Maximize Display
Maximizes the window.
window&lt;&lt;Maximize Window
Maximizes the window.
window&lt;&lt;Minimize Window
Minimizes the window.
window&lt;&lt;Move Window(x, y)
Moves the window to the specified position.
window&lt;&lt;On Close(script)
Runs the script when the window is closed.
window&lt;&lt;Pad Window(Boolean)
Turns padding around a window’s contents on (1) or off (0). The default value is off.
window&lt;&lt;Print Window
Prints the window to the default printer. Note that the Print window is not opened and
user input is not required.
Chapter 3
JSL Syntax Reference
JSL Messages
Display Boxes
331
window&lt;&lt;Reshow
Invalidates the display box and updates the window with the new content. See &lt;&lt;Inval
and &lt;&lt;Update Window messages if more control over timing of the update is required.
window&lt;&lt;Set Main Window
Sets the specified window as the default window that appears when JMP is run.
window&lt;&lt;Set Window Icon(&quot;icon name&quot;)
Sets the window’s icon as specified.
window&lt;&lt;Set Window Size(x, y)
Resizes the window.
window&lt;&lt;Show Window(0|1)
1 shows the window (brings it to the front). 0 hides the window. If the window is also
minimized (on Windows) or docked (on Macintosh), showing the window restores it to the
normal state and brings it to the front.
window&lt;&lt;Size Window(x, y)
Resizes the window.
window&lt;&lt;Update Window
Updates or refreshes the window holding the display box if there are invalidated regions.
See also &lt;&lt;Inval and &lt;&lt;Reshow messages for additional methods.
window&lt;&lt;Window Class Name
Returns the name of the window class for the display box. Valid responses include:
DataTable, FormulaEditor, Starter, Journal, Layout, Launcher, Report, Dialog,
DialogWithMenu, ModalDialog, FindReplace, User, Generic, ToolWindow, FindReplace,
AppBuilder, and Debugger.
window&lt;&lt;Zoom Window
Resizes the window to be large enough to show all of its contents.
332
JSL Messages
Dynamic Link Libraries (DLLs)
Chapter 3
JSL Syntax Reference
Dynamic Link Libraries (DLLs)
dll object&lt;&lt;Call DLL(function_name, signature, arguments)
Calls the specified function in the DLL with the specified signature and arguments.
dll object&lt;&lt;Declare Function(&quot;name&quot;, &lt;named_arguments&gt;)
Declares the return type and argument types for the specified function so that it can be
successfully invoked. You can use one of the named arguments for Convention: STDCALL or
PASCAL, or CDECL. The type argument for Returns takes the same named arguments as Arg.
Named Arguments
Alias(&quot;name&quot;)
Arg(type, &lt;&quot;description&quot;&gt;, &lt;access_mode&gt;, &lt;array&gt;) Arg is optional and can
appear multiple times, once for each argument to be sent to the function.
Type is one of these keywords that specifies the argument type: Int8, UInt8, Int16,
UInt16, Int32, UInt32, Int64, UInt64, Float, Double, AnsiString, UnicodeString,
Struct, IntPtr, UIntPtr, or ObjPtr.
&quot;description&quot; is an optional string that describes the argument for reference.
access_mode is an optional keyword that specifies how the argument is passed. input
specifies that the argument is passed by value. output specifies that the argument is
passed by address with the initial value undefined. update specifies that the argument is
passed by reference and the value of the JSL variable is set as the initial value. The
default value is input.
array is an optional keyword. It is valid only if the Type is specified as Double and the
access_mode is specified as either input or update. Specifies that the exported function
expects an array of doubles.
Convention(calling_convention) An optional keyword that specifies the calling
convention: STDCALL or PASCAL, or CDECL. The default value is STDCALL. STDCALL and
PASCAL are equivalent.
MaxArgs(n) An optional integer that specifies the maximum number of arguments that
can be supplied.
MinArgs(n) An optional integer that specifies the minimum number of arguments that
can be supplied.
Returns(type) Optional. Specifies the data type that the function returns: Int8, UInt8,
Int16, UInt16, Int32, UInt32, Int64, UInt64, Float, Double, AnsiString,
UnicodeString, Struct, IntPtr, UIntPtr, or ObjPtr.
StackOrder(order) Optional keyword that specifies the order in which arguments are to
be placed on the stack when calling the function. Valid values are L2R (left‐to‐right) and
R2L (right‐to‐left). The default value is R2L.
Chapter 3
JSL Syntax Reference
JSL Messages
Dynamic Link Libraries (DLLs)
333
StackPop(pop) Optional keyword that specifies how the exported function expects the
stack to be cleared after the function returns. Valid values are CALLER and CALLEE. The
default value is CALLEE.
StructArg(Arg(...), &lt;Arg(...)&gt;, ..., &lt;access_mode&gt;, &lt;pack_mode&gt;,
&lt;&quot;description&quot;&gt;) Optional and can appear multiple times. If an exported DLL function
requires that a structure argument be passed in as an argument, use StructArg to
declare the structure members. The Arg arguments use the same syntax as for Arg
arguments to DeclareFunction (one for each structure member), an access_mode
indicator and a pack_mode indicator.
access_mode is an optional keyword that indicates whether the struct argument should
be passed by value (input) or by reference (update).
pack_mode is an optional integer that determines how the structure is packed. Valid
values are 1, 2, 4, 8, and 16. The default value is 8.
description is an optional, quoted string that contains a description of the structure for
reference.
dll object&lt;&lt;Get Declaration JSL
Sends the declaration JSL from the DLL object to log.
dll object&lt;&lt;Load DLL(&quot;path&quot; &lt;,AutoDeclare(Boolean | Quiet |
Verbose)&gt;)
dll object&lt;&lt;Load DLL(&quot;path&quot; &lt;, Quiet | Verbose&gt;)
Loads the DLL from the specified path.
path A quoted pathname that specifies where to load the DLL.
AutoDeclare(Boolean | Quiet | Verbose) Optional argument. AutoDeclare(1) and
AutoDeclare(Verbose) write verbose messages to the log. AutoDeclare(Quiet) turns
off log window messages. If you omit this option, verbose messages are written to the
log.
Quiet | Verbose Optional argument. When you use Declare Function(), this option
turns off log window messaging (Quiet) or turns on log window messaging (Verbose).
dll object&lt;&lt;Show Functions
Sends the declared functions for the DLL object to the log.
dll object&lt;&lt;Unload DLL
Unloads the DLL.
334
JSL Messages
Images
Chapter 3
JSL Syntax Reference
Images
The Scripting Index provides examples for processing images. In JMP, select Help &gt; Scripting
Index to view this interactive resource.
Additional resources are available from the JMP File Exchange at https://community.jmp.com/
community/file‐exchange.
img&lt;&lt;Crop(Left(pix), Right(pix), Top(pix), Bottom(pix))
Creates a new image from an existing image to the specified dimensions (in pixels).
img&lt;&lt;Filter(&quot;name&quot;, &lt;n&gt;)
Filters the image based on the specified algorithm. Filtering is useful for cleaning up noise
in the image.
Note: All of the JMP image filters are supported at the operating system level. Images that are
processed on Windows might differ from images processed on Macintosh.
Argument
name A quoted string contains the name of a JMP image filter. The following filters are
available:
‒ &quot;despeckle&quot; removes defects (that is, speckles) from a scanned or captured image (for
example, scratches, dust, etc.).
‒ &quot;edge&quot; identifies pixels in an image where the brightness changes sharply and darkens
pixels with no sharp change. Edge detection is used to detect changes in surface, depth,
material, and lighting.
‒ &quot;enhance&quot; reduces the contrast between pixels in a noisy image.
‒ &quot;median&quot; reduces noise (that is, the random variation) and smooths an image by
comparing each pixel’s brightness with its neighbors’ and, if the value is very different,
replaces it with the average of the neighbors’ values.
‒ &quot;negate&quot; creates the negative of the color or gray‐scale image by changing each pixel
color to its complementary color.
‒ &quot;normalize&quot; changes a color image’s pixels to use the full range of the file format’s
number system. Normalization will make the image’s colors more intense.
‒ &quot;sharpen&quot; reduces blur by sharpening edges of an image.
‒ &quot;contrast&quot;, n brightens or darkens an image. A higher number (&gt;0.0) brightens an
image; a lower number (&lt;0.0) darkens an image.
Chapter 3
JSL Syntax Reference
JSL Messages
Images
335
‒ &quot;gamma&quot;, n corrects the image visual display (brightness and intensity) to account for
differences in monitor hardware. A higher number (&gt; 1.0) lightens the image; a lower
number (&lt; 1.0) darkens the image.
‒ &quot;reduce noise&quot;, n reduces the random variation (or noise) that occurs with higher ISO
sensitivity or longer exposure times.
‒ &quot;gaussian blur&quot;, radius, sigma reduces image noise and detail creating a smoother
image. Radius is equal to the blur radius around each pixel and sigma is the standard
deviation of the Gaussian distribution. Gaussian blur is commonly used when resizing
or performing edge detection.
img&lt;&lt;Flip Both
Flips the image from left to right and top to bottom.
img&lt;&lt;Flip Horizontal
Flips the image from left to right.
img&lt;&lt;Flip Vertical
Flips the image from top to bottom.
img&lt;&lt;Get Size
img&lt;&lt;Size
Returns a list containing the width and height (in pixels) of the image.
img&lt;&lt;Rotate(degrees)
Rotates the image by the specified number of degrees.
img&lt;&lt;Save Image(&quot;filepath&quot;)
Saves the image to the specified ʺpathʺ and ʺfilenameʺ.
img&lt;&lt;Scale(n, &lt;n&gt;)
Resizes the image by the specified dimensions. Provide one argument to resize both the
width and height. Provide two arguments to resize the width and height separately.
Examples
img = New Image( &quot;$SAMPLE_IMAGES/tile.jpg&quot; );
xs = 2;
img &lt;&lt; Scale( xs );
New Window( &quot;Tile x 2&quot;, img );
336
JSL Messages
Platforms
Chapter 3
JSL Syntax Reference
// Scale image width by 2 and height by 1/2
img = New Image( &quot;$SAMPLE_IMAGES/tile.jpg&quot; );
img &lt;&lt; Scale( 2, 0.5 );
New Window( &quot;Tile squished&quot;, img );
Notes
Using Scale is an alternative to getting the size of the image, multiplying by the scale
factor, and then setting the size.
img&lt;&lt;Set Size(width, height)
Resizes the image to the specified dimensions (in pixels). To scale the image proportionally,
specify a width and height that correspond to the aspect ratio in the original image.
img&lt;&lt;Transparency(fraction)
Sets the transparency for the image where the fraction is between 0.0 (full transparency) to
1.0 (no transparency).
Platforms
obj&lt;&lt;Bring Window To Front
Brings the current window to the front.
obj&lt;&lt;Close Window
Closes window identified by obj, typically a platform surface.
obj&lt;&lt;Column Switch(default column, {col 1, col 2, ...})
Adds a control panel to a platform for switching variables.
obj&lt;&lt;Data Table Window
Makes the associated data table window active (front‐most).
obj&lt;&lt;Get Data Table
Returns a reference to the data table.
obj&lt;&lt;Get Script
Returns script to reproduce the analysis as an expression.
Chapter 3
JSL Syntax Reference
JSL Messages
Platforms
337
obj&lt;&lt;Get Web Support
Returns the score for the display tree that is about to be saved as interactive HTML.
Possible values are ‐1 (unsupported), 0 (supported), and 1 (supported). If the score does not
equal ‐1, interactive HTML is supported and &lt;&lt;Save Interactive HTML() can be used.
obj&lt;&lt;Get Window Position
Gets the position of the window. Returns an ordered pair.
obj&lt;&lt;Get Window Size
Gets the window size, in pixels. Returns an ordered pair.
obj&lt;&lt;Journal Window
Appends the contents of the window to the journal.
obj&lt;&lt;Maximize Window
Maximizes the window. Equivalent to pushing the maximize button in the corner of the
window. This message takes an optional Boolean argument:
// maximize the window:
obj&lt;&lt;Maximize Window(1)
// restore the window:
obj&lt;&lt;Maximize Window(0)
obj&lt;&lt;Minimize Window
Minimizes the window. Equivalent to pushing the minimize button in the corner of the
window. This message takes an optional Boolean argument:
// minimize the window:
obj&lt;&lt;Minimize Window(1)
// restore the window:
obj&lt;&lt;Minimize Window(0)
obj&lt;&lt;Move Window(x, y)
Moves the window to the (x,y) location on your screen.
obj&lt;&lt;Print Window
Sends the selected window to the printer.
338
JSL Messages
Platforms
Chapter 3
JSL Syntax Reference
obj&lt;&lt;Redo Analysis
Launches the platform again with the same options.
obj&lt;&lt;Report
Report(obj)
Returns a display box reference for the report in the platform window.
obj&lt;&lt;Save Script for All Objects
Saves script to reproduce all analyses found within the object’s window in the Script
Journal window.
obj&lt;&lt;Save Script to Datatable
Saves script to reproduce analysis as a property in the associated data table.
obj&lt;&lt;Save Script to Report
Saves script to reproduce analysis as a text box at the top of the report.
obj&lt;&lt;Save Script for All Objects to Data Table
Saves a script for all report objects to the current data table. The script is named after the
platform unless you specify the script name in quotes.
obj &lt;&lt; Save Script for All Objects To Data Table(&quot;My Script&quot;)
obj&lt;&lt;Save Script to Script Window
Saves a script to reproduce analysis in the Script Journal.
obj&lt;&lt;Scroll Window(x, y)
obj&lt;&lt;Scroll Window({x, y})
Scrolls the window x pixels to the left and y pixels down from the current position.
obj&lt;&lt;Show Window(0|1)
1 shows the window (brings it to the front). 0 hides the window. If the window is also
minimized (on Windows) or docked (on Macintosh), showing the window restores it to the
normal state and brings it to the front.
Chapter 3
JSL Syntax Reference
JSL Messages
Platforms
339
obj&lt;&lt;Size Window(x, y)
Resizes the window to x pixels wide by y pixels high.
obj&lt;&lt;Zoom Window
Resizes the window to be large enough to show all of its contents.
Response Screening
obj&lt;&lt;Get PValues
Returns a reference to a PValues table.
obj&lt;&lt;Save PValues
Stores the p‐values in an output data table.
obj&lt;&lt;Save Compare Means
Stores the means comparisons in an output data table.
obj&lt;&lt;Save Mean
Stores the means in an output data table.
obj&lt;&lt;Save Outlier Indicator
Saves Outlier Indicator for each fit.
obj&lt;&lt;Save Std Residuals
Saves the residual formula for each fit.
obj&lt;&lt;Select Columns
Select columns in the original table corresponding to selected rows in this table.
Tabulate
obj&lt;&lt;Display Column Width(&lt;Data Column(Column
Table(n),&quot;colname_path&quot;), Row Label(Row Table(n), &quot;colname_path&quot;)&gt;,
&lt;width&gt;)
Returns or sets the display pixel width of a column in a Tabulate table.
340
JSL Messages
Platforms
Chapter 3
JSL Syntax Reference
Argument
data column Use Column Table and column references to define columns in the main
body of the table.
row label Use Row Table and heading for columns in the row labels area.
colname_path An optional Column Table or Row Table, and the series of column headings
that traces the path of the column. Note: Column table or row table can be omitted if the
table referenced is the first table.
width The pixel width of the column.
Examples
dt = Open( &quot;$SAMPLE_DATA/Car Poll.jmp&quot; );
obj = Tabulate(
Add Table(
Column Table(
Grouping Columns(
:sex,
:marital status
),
Analysis Columns( :age ),
Statistics( Sum, &quot;% of Total&quot; )
),
Row Table( Grouping Columns( :type ) ),
Row Table(
Grouping Columns( :country, :size )
)
)
);
wait(3); //for demonstration purposes
obj &lt;&lt;
Display Column Width(
Row Label( Row Table( 2 ), &quot;country&quot; ),
150
);
wait(3); //for demonstration purposes
obj &lt;&lt;
Display Column Width(
Data Column(Column Table(1), &quot;sex&quot;,&quot;Female&quot;, &quot;marital
status&quot;,&quot;Married&quot;,&quot;age&quot;,&quot;Sum&quot;),
150
);
Chapter 3
JSL Syntax Reference
JSL Messages
R Integration Messages
341
R Integration Messages
The R interfaces are also scriptable using an R connection object. A scriptable R connection
object can be obtained using the R Connect() JSL function.
rconn&lt;&lt;Control( Interrupt (1) )
If Async is set to true (1) for R Submit(), this message immediately stops the execution of
the R code that was submitted.
rconn&lt;&lt;Disconnect()
Disconnects this R connection.
rconn&lt;&lt;Is Connected()
Returns 1if the R connection is active, 0 otherwise.
rconn&lt;&lt;Send(&quot;name&quot;, named_arguments)
Send the specified JMP variable to R.
Returns
0 if successful, nonzero otherwise.
Argument
name A quoted string contains the name of a JMP variable to send to R.
Arguments for Data Tables
Selected(0|1) Optional, Boolean. If true, sends only the selected rows from the
referenced data table to R.
Excluded(0|1) Optional, Boolean. If true, sends only the excluded rows from the
referenced data table to R.
Labeled(0|1) Optional, Boolean. If true, sends only labeled rows from the referenced
data table to R.
Hidden(0|1) Optional, Boolean. If true, sends only hidden rows from the referenced data
table to R.
Colored(0|1) Optional, Boolean. If true, sends only colored rows from the referenced
data table to R.
Markered(0|1) Optional, Boolean. If true, sends only markered rows from the referenced
data table to R.
Row States(0|1, &lt;named arguments&gt;) Optional. Includes a Boolean argument and
optional named arguments. Sends row state information from the referenced data table
342
JSL Messages
R Integration Messages
Chapter 3
JSL Syntax Reference
to R by adding an additional data column named “RowState”. The row state value
consists of individual settings with the values shown in Table 3.1.
Table 3.1 Row States
Multiple row states are
created by adding
together individual
settings.
Selected = 1
Excluded = 2
Labeled = 4
Hidden = 8
Colored = 16
Markered = 32
Arguments
Colors(Boolean) Optional, Boolean. If true, sends row
colors and adds an additional data column named
“RowStateColor”.
Markers(Boolean) Optional, Boolean. If true, sends row
markers and adds an additional data column named
“RowStateMarker”.
rconn&lt;&lt;Send(&quot;name&quot;)
Send the specified JMP data file to R.
rconn&lt;&lt;Get(&quot;name&quot;)
Gets the specified variable from R.
Returns
The value of the specified variable.
Arguments
name A quoted string that contains the name of a JMP variable to be retrieved from R.
rconn&lt;&lt;Get Graphics(&quot;type&quot;)
Gets the last graphics object written to the R graph display window. The graphics object can
be returned in different graphic formats.
Returns
A JMP picture object.
Arguments
type The format the R graph display window contents are to be converted to. Valid
formats are &quot;png&quot;, ʺbmpʺ, ʺjpegʺ, ʺjpgʺ, ʺtiffʺ, and ʺtifʺ.
Chapter 3
JSL Syntax Reference
JSL Messages
R Integration Messages
343
rconn&lt;&lt;Submit(&quot;code&quot;, named_arguments)
Submits the R code.
Returns
0 if successful, nonzero otherwise.
Arguments
code A quoted string that contains the R code to submit.
Expand(0|1) Optional, Boolean. Performs an Eval Insert() on the R code before
submitting the code.
Echo(0|1) Optional, Boolean. Echoes the R source lines to the JMP log. The default value
is true.
Rconn&lt;&lt;Submit File(&quot;filepath&quot;)
Submits statements to R using the file in the ʺfilepathʺ.
Arguments
filepath A quoted string that contains the pathname to the file that contains R code to be
executed.
rconn&lt;&lt;Execute({ list of inputs }, { list of outputs }, &quot;code&quot;,
named_arguments)
Submits the R code to the R connection using the list of inputs. Upon completion, a list of
outputs is returned.
Returns
0 if successful, nonzero otherwise.
Arguments
{ list of inputs } List of JMP variable names to be sent to R as inputs.
{ list of outputs } List of JMP variable names to be retrieved from R as outputs.
code A quoted string that contains the R code to submit.
named_arguments See rconn&lt;&lt;Submit(&quot;code&quot;, named_arguments) on page 343.
rconn&lt;&lt;Control(named_arguments)
Controls the execution of R.
Returns
Void.
Argument
Echo(Boolean) Optional, Boolean. Echoes the R source lines to the JMP log.
344
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
rconn&lt;&lt;Get Version()
Gets the current version of R that is installed.
Returns
A vector of length 3 containing the R version number.
rconn&lt;&lt;JMP Name To R Name(&quot;name&quot;)
Maps a JMP Name to its corresponding R Name using R variable name naming rules.
Returns
A string that contains the R name.
Arguments
name A quoted string that contains the name of a JMP variable to be sent to R.
SAS Integration Messages
Metadata Server Objects
metaserver&lt;&lt;Disconnect()
Function
Disconnects the metadata server.
Returns
Void.
metaserver&lt;&lt;Get Display Name()
Function
Gets the display name of the metadata server.
Returns
A string.
metaserver&lt;&lt;Get Host Name()
Function
Gets the host (machine) name of the metadata server.
Returns
A string.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
345
metaserver&lt;&lt;Get Port()
Function
Gets the port used for the metadata server connection.
Returns
An integer.
metaserver&lt;&lt;Get User Identity()
Function
Gets the identify of the connected user as defined in metadata.
Returns
A string.
metaserver&lt;&lt;Get User Name()
Function
Gets the user name (login ID) that was used for the metadata server connection.
Returns
A string.
SAS Server Objects
sasconn&lt;&lt;Assign Libref(&quot;libref&quot;, &quot;path&quot;, engine, engine options)
Function
Assign a SAS libref on this SAS server connection.
Returns
Void.
Arguments
See “SAS Assign Lib Refs(ʺlibrefʺ, ʺpathʺ, &lt;ʺengineʺ&gt;, &lt;ʺengine optionsʺ&gt;)” on page 216 in
the “JSL Functions” chapter.
sasconn&lt;&lt;Cancel Submit()
Function
Cancels the currently running SAS Submit for this server that is presumably running
asynchronously.
Returns
1 if a running submit was found and canceled; 0 otherwise.
346
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
sasconn&lt;&lt;Clear Log History()
Function
Clears the SAS Log history for this server.
Returns
Void.
sasconn&lt;&lt;Clear Output History()
Function
Clears the SAS Output history for this server.
Returns
Nothing
sasconn&lt;&lt;Connect(&lt;named arguments&gt;)
Function
Attempt to reconnect a SAS server connection object that has become disconnected.
Returns
1 if the connection was successful, 0 otherwise.
Named Arguments
All named arguments are optional.
UserName(&quot;name&quot;) A quoted string that contains the user name for the connection.
Password(&quot;password&quot;) A quoted string that contains the password for the connection.
Prompt(Always|Never|IfNeeded) A keyword. Always means always prompt before
attempt to connect. Never means never prompt even if the connection attempt fails (just
fail with an error message going to the log), and IfNeeded (the default) means prompt if
the attempt to connect with the given arguments fails (or is not possible with the
information given).
sasconn&lt;&lt;Deassign Libref(&quot;libref&quot;)
Function
De‐assign a SAS libref on this SAS server connection.
Returns
Void.
Arguments
libref Quoted string that contains the library reference.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
347
sasconn&lt;&lt;Disconnect()
Function
Disconnect this SAS server connection.
Returns
Void.
sasconn&lt;Does Module Exist(&quot;moduleName&quot;)
Function
Determines whether the specified SAS module exists in the SAS installation represented by
the SAS connection. This can be helpful in determining whether certain SAS products are
installed. The SAS DATA Step function MODEXIST is used to determine module existence.
Because MODEXIST is new for SAS 9.2, this function throws an exception if it is called for a
SAS connection that is not version SAS 9.2 or later.
Returns
1 if the specified module is found to exist, 0 if it does not exist.
Argument
moduleName The quoted SAS module, the existence of which should be checked. Do not
include any extension.
sasconn&lt;&lt;Export Data(dt, &quot;library&quot;, &quot;dataset&quot;, &lt;named arguments&gt;)
Function
Exports a JMP data table to the specified SAS data set in the specified library on the active
SAS server connection.
Returns
1 if the data table was exported successfully; 0 otherwise.
Arguments
See “SAS Export Data(dt, ʺlibraryʺ, ʺdatasetʺ, &lt;named_arguments&gt;)” on page 219 in the
“JSL Functions” chapter.
sasconn&lt;&lt;Get Data Sets(&quot;libref&quot;)
Function
Returns a list of the data sets defined in a SAS library on this SAS server connection.
Returns
List of strings.
348
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
Arguments
libref Quoted string that contains the SAS libref or friendly library name associated with
the library for which the list of defined SAS data sets will be returned.
sasconn&lt;&lt;Get Error Count()
Function
Gets the count of the number of errors encountered in the previous SAS Submit.
Returns
An integer.
sasconn&lt;&lt;Get File(&quot;source&quot;, &quot;dest&quot;)
Function
Download a file from this SAS server connection.
Returns
Void.
Arguments
See “SAS Get File(ʺsourceʺ, ʺdestʺ, ʺencodingʺ)” on page 220 in the “JSL Functions” chapter.
sasconn&lt;&lt;Get File Names(&quot;fileref&quot;)
Function
Get a list of filenames found in the given ʺfilerefʺ on this SAS server connection.
Returns
List of strings.
Arguments
fileref Quoted string that contains the name of fileref from which to retrieve filenames.
sasconn&lt;&lt;Get File Names In Path(&quot;path&quot;)
Function
Get a list of filenames found in the given &quot;path&quot; on this SAS server connection.
Returns
List of strings.
Arguments
path Quoted string that contains the directory path on the server from which to retrieve
filenames.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
349
sasconn&lt;&lt;Get File Refs()
Function
Get a list of the currently defined SAS filerefs on this SAS server connection.
Returns
List of strings.
sasconn&lt;&lt;Get Librefs(&lt;named arguments&gt;)
Function
Get a list of the currently defined SAS librefs on this SAS server connection.
Returns
List of strings.
Arguments
See “SAS Get Lib Refs(&lt;named arguments&gt;)” on page 221 in the “JSL Functions” chapter.
sasconn&lt;&lt;Get Log()
Function
Retrieve the SAS Log from the last SAS Submit from this SAS server connection.
Returns
String.
sasconn&lt;&lt;Get Option Name()
Function
Query SAS for the value of a SAS option variable.
Returns
String.
Example
The following script iterates through the define variables and prints out the values:
option_names = sasconn &lt;&lt; Get Option Names();
For(i=1, i &lt;= N Items(option_names), i++,
option_value = sasconn &lt;&lt; Get Option Value (option_names[i]);
output = option_names[i] || &quot;=&quot; || char(option_value) || &quot;\!n&quot;;
Write(output);
);
350
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
sasconn&lt;&lt;Get Output()
Function
Retrieve the listing output from the last submission of SAS code to this SASServer object.
Returns
String.
sasconn&lt;&lt;Get Results()
Function
Retrieve the results of the previous SAS Submit as a scriptable object, which allows
significant flexibility in what to do with the results.
Returns
A SAS Results Scriptable Object.
sasconn&lt;&lt;Get Submit Status()
Function
Gets the current status of a SAS Submit for this server that is presumably running
asynchronously.
Returns
1 if the submit has not started; 2 if the submit is running; 3 if the submit has been canceled;
10 if the submit has completed successfully; 11 if the submit has completed with errors.
sasconn&lt;&lt;Get Var Info(&quot;libref&quot;, &quot;dataset&quot;, &lt;&quot;password&quot;&gt;)
Function
Returns information about the variables the specified SAS data set.
Arguments
libref Quoted string that contains the library reference to de‐assign.
dataset Quoted string that contains the name of the data set from which to retrieve
variable names.
Password(&quot;password&quot;) A quoted string that contains the password for the connection.
sasconn&lt;&lt;Get Var Names(&quot;libref&quot;, &quot;dataset&quot;, &lt;named arguments&gt;)
Function
Retrieves the variable names contained in the specified data set on this SAS server
connection.
Returns
List of strings.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
351
Arguments
See “SAS Get Var Names(string, &lt;ʺdatasetʺ&gt;, &lt;password(ʺpasswordʺ)&gt;)” on page 222 in the
“JSL Functions” chapter.
sasconn&lt;&lt;Get Version(&lt;&quot;long&quot;&gt;)
Function
Returns the SAS version as a string such as “9.1” or “9.2”.
Returns
A string that contains the SAS version.
Argument
long An optional quoted keyword that specifies to return the long SAS version, which
corresponds to the SYSVLONG SAS macro. For example, ʺ9.02.02M0P01152009ʺ.
sasconn&lt;&lt;Get Work Folder()
Function
Returns the full path of the folder corresponding to the WORK library for this server.
Returns
A string that contains the work folder path.
sasconn&lt;&lt;Import Data(&quot;library&quot;, &quot;dataset&quot;, &lt;named arguments&gt;)
Function
Import a SAS data set from this SAS server connection into a JMP table.
Returns
JMP Data Table object.
Arguments
See “SAS Import Data(string, &lt;ʺdatasetʺ&gt;, &lt;named arguments&gt;)” on page 223 in the “JSL
Functions” chapter.
sasconn&lt;&lt;Import Query(&quot;sqlquery&quot;, &lt;named arguments&gt;)
Function
Execute the requested SQL query on this SAS server connection, importing the results into
a JMP data table.
Returns
JMP data table object.
352
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
Arguments
See “SAS Import Query(ʺsqlqueryʺ, &lt;named arguments&gt;)” on page 225 in the “JSL
Functions” chapter.
sasconn&lt;&lt;Is Connected()
Function
Determine whether this SAS Server object is currently connected to SAS.
Returns
1 if sasconn is connect, 0 otherwise.
sasconn&lt;&lt;Is Product Available(&quot;productName&quot;)
Function
Determine whether the quoted SAS product is both licensed and installed in the session
represented by the SAS connection. The SAS DATA Step functions SYSPROD and
MODEXIST are used to determine the licensed and installed status of the product.
Returns
1 if the specified product is licensed, 0 if the product is not licensed, or ‐1 if the specified
product is not recognized by SAS. This function throws an exception if the requested
product is not one for which JMP knows how to check the installed status.
Argument
productName The quoted SAS product for which licensing should be checked. The product
name can be specified with or without the “SAS/” prefix.
Note
The MODEXIST function is new in SAS 9.2. For SAS 9.1.3, this function only checks the
license, not the installed status. In other words, for SAS 9.1.3, this function operates the
same way as Is Product Licensed().
sasconn&lt;&lt;Is Product Licensed(&quot;productName&quot;)
Function
Determines whether the quoted SAS product is licensed in the session represented by the
SAS connection. The SAS DATA Step function SYSPROD is used to determine the licensing
status of the product.
Returns
1 if the specified product is licensed, 0 if the product is not licensed, or ‐1 if the specified
product is not recognized by SAS.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
353
Argument
productName The quoted SAS product for which licensing should be checked. The product
name can be specified with or without the “SAS/” prefix.
sasconn&lt;&lt;Kill Session(&lt;n&gt;)
Function
Immediately terminates the SAS connection.
Returns
Void.
Arguments
n An optional number. The system waits n seconds for a normal shut‐down before
immediately terminating the SAS connection.
sasconn&lt;&lt;Load Text File(&quot;path&quot;, &lt;named arguments&gt;)
Function
Download the file specified in ʺpathʺ from the active SAS server connection and retrieve
its contents as a string.
Returns
String.
Arguments
See “SAS Load Text File(ʺpathʺ)” on page 226 in the “JSL Functions” chapter.
sasconn&lt;&lt;Open Log Window()
Function
Opens (or brings to the front) the SAS Log window for this server.
Returns
Void.
sasconn&lt;&lt;Open Output Window()
Function
Opens (or brings to the front) the SAS Output window for this server.
Returns
Void.
354
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
sasconn&lt;&lt;Open SAS Results()
Function
Open the results from the previous SAS Submit. Intended to be used with asynchronous
SAS submits or the use of the OnSubmitComplete option to SAS Submit to give the JSL
author a way to conditionally open the results of a submit.
Returns
Void.
sasconn&lt;&lt;Open Submit Results()
Function
Opens all the results from the last SAS Submit command.
Returns
Void.
sasconn&lt;&lt;Send File(&quot;source&quot;, &quot;dest&quot;)
Function
Upload a file to this SAS server connection.
Returns
Void.
Arguments
See “SAS Send File(ʺsourceʺ, ʺdestʺ, ʺencodingʺ)” on page 227 in the “JSL Functions”
chapter.
sasconn&lt;&lt;Submit(sasCode, &lt;named arguments&gt;)
Function
Submit some SAS code to this SAS server connection.
Returns
Void.
Arguments
See “SAS Submit(ʺsasCodeʺ, &lt;named arguments&gt;)” on page 227 in the “JSL Functions”
chapter.
sasconn&lt;&lt;Submit File(&quot;filename&quot;, &lt;named arguments&gt;)
Function
Submit a SAS code file to this SAS server connection.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
355
Returns
Void.
Arguments
See “SAS Submit File(ʺfilenameʺ, &lt;named arguments&gt;)” on page 229 in the “JSL Functions”
chapter.
Stored Processes
stp&lt;&lt;Begin Run(&lt;named arguments&gt;)
Function
Start this stored process executing in the background. This message is paired with End Run,
which should also be called at some point after Begin Run to wait for the stored process to
complete.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
Same as Run, except AutoOpenResults and NoAlerts are not supported. They are available
on EndRun.
AutoResume(&lt;&quot;filename&quot;&gt;) Optional, quoted string. If specified with no argument, it
specifies that the stored process results should be auto‐opened when the stored process
completes. If filename is specified, filename is opened rather than all results of the stored
process being auto‐opened.
AutoResumeScript(&quot;script&quot;) Optional, quoted string that specifies that after stored
process execution completes, script should be evaluated. If the script is a function taking
at least one argument, the function is evaluated with the scriptable stored process object
passed as the first (and only) argument. AutoResume and AutoResumeScript are mutually
exclusive.
stp&lt;&lt;Delete Results(&lt;named arguments&gt;)
Function
Delete all results from the execution of this stored process.
356
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
Returns
1 if deletion is successful, 0 otherwise (error message to JMP log).
Arguments
NoAlerts(0|1) Optional, Boolean. If True, the user is not prompted for confirmation
before the attempt is made to delete results.
DeleteDirectory(0|1) Optional, Boolean. If true, deletes the directory containing the
stored process results along with the result files themselves. The default value is true.
stp&lt;&lt;Edit Param Values()
Function
Opens the stored process window for interactively setting parameter values.
Returns
1 if the user clicks OK to dismiss the window, 0 if the user clicks Cancel.
stp&lt;&lt;End Run(&lt;named arguments&gt;)
Function
Waits a specified amount of time (or forever) for a stored process started with Begin Run to
complete. If the stored process is complete, retrieves the results, and opens them.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
AutoOpenResults(0|1) Optional, Boolean. If True, results are automatically opened if the
stored process completes in the time specified by MaxWait. If False, results are not
automatically opened, and can be manually opened via the object returned by the Get
Results message. Default is True.
MaxWait(milliseconds) Optional, an integer. Specifies the maximum amount of time in
milliseconds to wait for the stored process to complete. If MaxWait is not specified, End
Run waits forever for the stored process to complete.
NoAlerts(0|1) Optional, Boolean. If True, error messages are sent to the JMP log rather
than message boxes. The default value is False.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
357
stp&lt;&lt;Get Metadata Id()
Function
Returns the metadata ID of the stored process.
Returns
String.
stp&lt;&lt;Get Metadata Path()
Function
Returns the full metadata path of the stored process.
Returns
String.
Stp&lt;&lt;Get Name()
Function
Returns the name of the stored process.
Returns
String.
stp&lt;&lt;Get Param Enum Labels(&quot;name&quot;)
Function
Get the enumeration labels for a parameter.
Returns
List of strings.
Arguments
name Quoted string that contains the name of the parameter whose enumeration labels to
retrieve.
stp&lt;&lt;Get Param Enum Values(&quot;name&quot;)
Function
Get the possible enumerated values for a parameter.
Returns
List of strings.
Arguments
name Quoted string that contains the name of the parameter whose possible enumerated
values to retrieve.
358
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
stp&lt;&lt;Get Param Names(&lt;named arguments&gt;)
Function
Get a list of parameter names for this stored process of specific types.
Returns
List of strings.
Arguments
Visible(0|1) Optional, Boolean. If True, get only visible parameters. If False, get only
non‐visible parameters. If not specified, get both visible and non‐visible parameters.
Modifiable(0|1) Optional, Boolean. If True, get only modifiable parameters. If False, get
only non‐modifiable parameters. If not specified, get both modifiable and
non‐modifiable parameters.
Required(0|1) Optional, Boolean. If True, get only required parameters. If False, get
only non‐required parameters. If not specified, get both required and non‐required
parameters.
Expert(0|1) Optional, Boolean. If True, get only expert parameters. If False, get only
non‐expert parameters. If not specified, get both expert and non‐expert parameters.
stp&lt;&lt;Get Param Value(&quot;name&quot;)
Function
Get the current value of the specified parameter.
Returns
String.
Arguments
name Quoted string that contains the name of the parameter whose value to retrieve.
stp&lt;&lt;Get Results()
Function
Get the results generated by the execution of this stored process as a scriptable object.
Returns
SAS Results scriptable object.
stp&lt;&lt;Get Status()
Function
Get the execution status of the stored process.
Returns
-1 = execution failed.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
359
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
stp&lt;&lt;Get Status Message()
Function
Get the message associated with the failure of the stored process, if any.
Returns
String.
stp&lt;&lt;Reset Param Values()
Function
Reset all parameter values to their metadata‐defined default values.
Returns
Void.
stp&lt;&lt;Run(&lt;named arguments&gt;)
Function
Execute this stored process object in the foreground.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
AutoOpenResults(0|1) Optional, Boolean. If True, results are automatically opened
when the stored process completes. If False, results are not auto‐opened, and can be
manually opened via the object returned by the GetResults message. The default value
is True.
UserName(&quot;username&quot;) Optional, quoted string that contains the user name under which
to run the stored process.
360
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
Password(&quot;password&quot;) Optional, quoted string that contains the password for Username.
AuthDomain(&quot;authDomain&quot;) Optional, quoted string that contains the authentication
domain of the credentials (username, password) given.
ODSDest(&quot;dest&quot;) Optional, quoted string that contains an ODS destination (HTML, PDF,
tagsets.SASReport12) for any ODS‐generated results from the stored process. This
requires the stored process SAS code to call %STPBEGIN. The default value is HTML.
GraphicsDevice(&quot;device&quot;) Optional, quoted string that contains the SAS graphics
device to use when generating graphics in ODS results. This requires the stored process
SAS code to call %STPBEGIN. The default value is GIF.
ODSStyle(&quot;styleName&quot;) Optional, quoted string that contains an ODS style to apply to
the results. This requires the stored process SAS code to call %STPBEGIN. There is no
default value.
ODSStyleSheet(&quot;cssFile&quot;) Optional, quoted string that contains the full path to a CSS
file on the client machine that is to be applied to generated ODS results. This requires the
stored process SAS code to call %STPBEGIN. There is no default value.
NoAlerts(0|1) Optional, Boolean. If True, error messages are sent to the JMP log rather
than message boxes. The default value is False.
stp&lt;&lt;Set Param Value(&quot;name&quot;, &quot;value&quot;)
Function
Sets the value of the specified stored process parameter to the specified value.
Returns
1 if successful, 0 otherwise (value can violate the parameter’s constraints).
Arguments
name Quoted string that contains the name of the parameter whose value to set.
value Quoted string that contains the value to which to set the parameter.
stp&lt;&lt;Set Results Directory(&quot;directory&quot;)
Function
Sets the directory on the client machine where stored process results are placed.
Returns
String.
Arguments
directory Quoted string that contains the full path of the directory where results of the
stored process execution should be placed. The directory must exist or be creatable. If the
results directory is not set, a temporary location appropriate for the operating system
will be used, and that directory can be retrieved from the stored process Results
scriptable object after the stored process executes.
Chapter 3
JSL Syntax Reference
JSL Messages
SAS Integration Messages
361
SAS Results
results&lt;&lt;Delete All Result Files()
Function
Deletes all files created by the SAS Submit or Stored Process execution. Note that any result
files that are still in use are not deleted.
Returns
1 if the deletion was successful; 0 if some of the files could not be deleted.
results&lt;&lt;Get Directory()
Function
Gets the directory where the results generated by the stored process or SAS submit are
located.
Returns
String.
results&lt;&lt;Get Log()
Function
Get the SAS Log from the execution of the stored process or SAS submit.
Returns
String.
results&lt;&lt;Get Main Result File Name(&lt;named arguments&gt;)
Function
Gets the full path of the main result file generated by the stored process or SAS submit.
Returns
String.
Arguments
FullPath(0|1) Optional, Boolean. If True, the main result filename is returned as a full
path. The default value is False.
results&lt;&lt;Get Output()
Function
Gets the SAS Listing output from the execution of the stored process or SAS submit.
Returns
String.
362
JSL Messages
SAS Integration Messages
Chapter 3
JSL Syntax Reference
results&lt;&lt;Get Output Datasets()
Function
Get a list of output data set generated by the SAS Submit that created this SAS Results
object.
Returns
A list of data set names in the form “libname.membername”.
results&lt;&lt;Get Result File Info(&lt;MIMEType(&quot;mime-type&quot;)&gt;, &lt;FullPath&gt;)
Function
Get information about result files that were generated by the execution of the stored
process or SAS submit.
Returns
List of two lists of strings. The first list is filenames, and the second list is the MIME‐type of
the corresponding file from the first list.
Arguments
MIMEType(&quot;mime_type&quot;) Optional, quoted string that restricts the set of files for which
information is returned to only those files with the specified MIME‐type. If not specified,
information about all generated files is returned.
FullPath Optional, Boolean. If True, the filename returned for each result file is returned
as a full path; if False, only the name of the file is returned. The default value is False.
results&lt;&lt;Make JMP Report()
Function
Parses the ODS XML results and creates a JMP report.
Returns
The display box for the report.
results&lt;&lt;Open All Results()
Function
Opens all results generated by the execution of the stored process or SAS submit.
Returns
Void.
results&lt;&lt;Open Result File(&quot;filename&quot;, &lt;named arguments&gt;)
Function
Attempts to open the result file with the given name.
Chapter 3
JSL Syntax Reference
JSL Messages
Schedule
363
Returns
JMP Data Table if one was opened.
Arguments
filename Quoted string that contains the name of the file from the generated results to
open. filename should just be the name of the file, not the full path. If filename is a
filename with no extension, both JMP data tables and JSL scripts in the results are
searched for a match, and if both exist, both are opened.
RunScript(0|1) Optional, Boolean. If True, and if filename is a JSL script, the script is
executed. If False, filename is just opened, even if it is JSL.
results&lt;&lt;Run Script(&quot;filename&quot;)
Function
Looks for a JSL file in the results with the given filename and runs it if it finds it.
Returns
Void.
Arguments
filename Quoted string that contains the name of the JSL file from the generated results to
open. Filename should just be the name of the file, not the full path, and it does not need
to include the .jsl extension.
Schedule
See also “Schedule(n, script)” on page 269 in the “JSL Functions” chapter.
For more information about scheduling actions, see the Programming chapter in the Scripting
Guide.
sch&lt;&lt;Clear Schedule()
Cancels all scheduled events.
sch&lt;&lt;Close()
Closes the scheduler.
sch&lt;&lt;Restart()
Restarts the scheduler after it was stopped from running all scheduled events.
364
JSL Messages
Sockets
Chapter 3
JSL Syntax Reference
sch&lt;&lt;Show Schedule()
Shows a list of all scheduled events.
sch&lt;&lt;Stop()
Stops the scheduler from running all scheduled events.
Sockets
skt&lt;&lt;Accept(&lt;callback, timeout&gt;)
Function
Tells the server socket to accept a connection and return a new connected socket.
Returns
A list of up to four items. The first is a string that echoes the command (&quot;accept&quot;). The
second is a string, either &quot;ok&quot; or an error. The third is a string that specifies the name of the
machine that just connected. The fourth is a reference to the socket that you can send more
messages.
Arguments
callback an optional argument that specifies the name of a function to receive the data.
timeout if you use a callback, timeout specifies how long the function should wait for
an answer. For a server socket, 0 is an acceptable value because a server should not shut
down because no one has connected to it recently.
skt&lt;&lt;bind(&quot;localhost&quot;, port)
Function
Associates a port on the local machine with the socket.
Returns
A list of two strings. The first string is the command name (“bind”) and the second is “ok”
if successful or an error.
Argument
localhost Specifies the local machine. You cannot bind to another machine.
port The port that should be used.
skt&lt;&lt;Close()
Function
Closes a socket.
Chapter 3
JSL Syntax Reference
JSL Messages
Sockets
365
Returns
A list of two strings. The first string is the command name (“close”) and the second is “ok”
if successful.
skt&lt;&lt;Connect(socketname, port)
Function
Connects to a listening socket.
Returns
A list of two strings. The first string is the command name (“connect”) and the second is
“ok” for a successful connection or an error sent back by the other socket.
Arguments
socketname the name of the other socket. If you are connecting to a web server, this is the
web address (the name is preferred to the IP address).
port the port of the other socket to connect through.
skt&lt;&lt;GetPeerName()
Function
Retrieves the address and port of the socket at the other end of the connection.
Returns
A list of four strings. The first echoes the command (&quot;getpeername&quot;). The second is either
“ok” or an error. The third and fourth are the address and the port.
skt&lt;&lt;GetSockName()
Function
Retrieves the address and port of the socket at this end of the connection.
Returns
A list of four strings. The first echoes the command (&quot;getsockname&quot;). The second is either
“ok” or an error. The third and fourth are the address and the port.
skt&lt;&lt;ioctl(FIONBIO, 1)
Function
Controls the socket’s blocking behavior.
Returns
A list of two strings. The first string is the command name (“ioctl”) and the second is “ok” if
successful or an error.
366
JSL Messages
Sockets
Chapter 3
JSL Syntax Reference
Arguments
FIONBIO, 1 FIONBIO means Non‐Blocking I/O. 1 turns on the behavior and the argument.
skt&lt;&lt;Listen()
Function
Tells the server socket to listen for connections.
Returns
A list of two strings. The first echoes the command (&quot;listen&quot;) and the second is &quot;ok&quot; or an
error message.
skt&lt;&lt;recv(n, &lt;callback, timeout&gt;)
skt&lt;&lt;recvfrom(n, &lt;callback, timeout&gt;)
Function
Receives either a stream message (recv) or a datagram message (recvfrom) from the other
socket. If the two optional arguments are used, the data is not received immediately.
Instead, the data is received when the function callback is called.
Returns
A list of three strings. The first string is the command name (“recv” or “recvto”). The
second is “ok” if successful or an error message if not. The third string is the data that was
received. If a callback function is used, a fourth element is the socket that was used in the
original recv or recvfrom message.
Arguments
n specifies the number of bytes to receive from the other socket.
callback an optional argument that specifies the name of a function to receive the data.
timeout if you use a callback, timeout specifies how long the function should wait for
an answer.
skt&lt;&lt;Send(stream)
skt&lt;&lt;SendTo(dgram)
Function
Sends the data in the argument to the other socket. Send sends a stream and sendto sends a
datagram.
Returns
A list of three strings. The first string is the command name (“send” or “sendto”). The
second is “ok” if successful or an error message if not. The third string is any portion of the
stream that could not be sent, or empty if all the data was sent correctly.
Chapter 3
JSL Syntax Reference
JSL Messages
SQL
367
Arguments
stream the command to send to the other socket.
dgram the command to send to the other socket.
Note
Either argument might need to contain binary data. JMP represents non‐printable ASCII
characters with a tilde (~) followed by the hexadecimal number. For example,
skt&lt;&lt;send((&quot;GET / HTTP/1.0~0d~0a~0d~0a&quot;);
sends a “get request” to an HTTP server.
SQL
sqlquery&lt;&lt;Generate SQL
Returns the SQL that the query generates when you run it.
obj&lt;&lt;Run(&lt;private&gt;, &lt;UpdateTable(table)&gt;, &lt;OnRunComplete(script)&gt;,
&lt;OnRunCanceled(script)&gt;, &lt;OnError(script)&gt;
Description
Runs the SQL query in the background or foreground depending on the Query Builder
preference “Run queries in the background when possible”.
Returns
Null (if the query runs in the background) or a data table (if the query runs in the
foreground).
Arguments
private Optional. Opens the data table that the query produces without displaying it in a
data table window.
UpdateTable Optional. Updates the specified data table. Runs the query in the
foreground.
OnRunComplete Optional. Specifies a script to run after the query is complete.
OnRunCanceled Optional. Specifies a script to run after the user cancels the query.
OnError Optional. Specifies a script to run if an error occurs.
Notes
If you want the data table that results from the background query, use the OnRunComplete
optional argument. You can include a script that runs when the query completes and then
assigns a data table reference to the resulting data table. Or you might pass the name of a
function that accepts a data table as its first argument. That function is called when the
query completes.
368
JSL Messages
Tree Node and Tree Box
Chapter 3
JSL Syntax Reference
Examples
The following example opens a query that you previously saved from Query Builder. The
query opens privately, that is, without opening Query Builder. The query runs, and the
resulting data table opens.
query = Open( &quot;c:/My Data/Movies.jmpquery&quot;, private);
dt = query &lt;&lt; Run();
The following example queries the database, opens the resulting data table, and prints the
number of data table rows to the log.
confirmation = Function( {dtResult},
Write( &quot;\!NNumber of rows in query result: &quot;, N Rows( dtResult ) )
);
query = New SQL Query(
Connection(
&quot;ODBC:DSN=SQL
Databases;APP=MYAPP;TrustedConnection=yes;WSID=D79255;DATABASE=SQB;&quot;
),
QueryName( &quot;movies_to_update&quot; ),
Select( Column( &quot;YearMade&quot;, &quot;t1&quot; ), Column( &quot;Rating&quot;, &quot;t1&quot; ) ),
From( Table( &quot;g6_Movies&quot;, Schema( &quot;SQB&quot; ), Alias( &quot;t1&quot; ) ) ),
);
query &lt;&lt; Run( OnRunComplete( confirmation ) );
Tree Node and Tree Box
For the following messages, node stands for a tree node or a reference to one and root stands
for a tree box or a reference to one.
node &lt;&lt;Append(&lt;node_ref&gt;)
Inserts a referenced tree node after this node’s children.
root &lt;&lt;Collapse(&lt;node&gt;)
Collapses the given tree node.
root &lt;&lt;Expand(&lt;node&gt;)
Expands the given tree node.
root &lt;&lt;Get Selected(&lt;node&gt;)
Gets the currently selected tree node.
Chapter 3
JSL Syntax Reference
JSL Messages
Triangulation
369
‒ In a single‐item tree, the currently selected tree node or Empty is returned.
‒ Table 3.2 shows the results for a Tree Box() that contains the MultiSelect argument.
Table 3.2 Multi‐Select Tree Results
Items Selected in Tree
Result
no items selected
empty
single item selected
list of one tree node
multiple items selected
list of selected tree nodes
root &lt;&lt;Is Multiselect
Returns 1 for a MultiSelect tree and 0 for a single‐select tree.
node &lt;&lt;Prepend(&lt;node_ref&gt;)
Inserts a tree node before this node’s children.
node &lt;&lt;Remove(&lt;node&gt;)
Removes the given tree node and all its children from the tree display box.
root &lt;&lt;Set Selected(node|{nodes}, &lt;0|1&gt;)
Selects the given tree node in the tree display box. In list of tree nodes, all nodes in the list
are selected for MultiSelect trees. Otherwise, the first node in the list is selected. Specify
the Boolean argument to indicate whether the node or nodes should be selected or
unselected. The default value is 1, which selects the nodes.
Notes:
•
On Windows, the &lt;&lt;Set Selected() message expands all nodes between the selected
node or nodes and the root of the tree; items that are selected deep within the tree are
shown. The expansion state does not change for nodes that were previously selected.
•
On Macintosh, &lt;&lt;Set Selected() does not change the tree expansion state.
Triangulation
For the following messages, tri stands for a triangulation or a reference to one.
tri &lt;&lt;Get N Points
Returns the number of unique points in the triangulation.
370
JSL Messages
Triangulation
tri &lt;&lt;Get Points
Returns the coordinates of the unique points in the triangulation.
tri &lt;&lt;Get Y
Returns the Y values of the unique points in the triangulation.
tri &lt;&lt;Get N Hull Points
Returns the number of points on the boundary of the triangulation.
tri &lt;&lt;Get Hull Points
Returns the indices of the points on the boundary of the triangulation.
tri &lt;&lt;Get N Hull Edges
Returns the number of edges on the boundary of the triangulation.
tri &lt;&lt;Get Hull Edges
Returns the indices of the edges on the boundary of the triangulation.
tri &lt;&lt;Get Hull Path
Returns the boundary of the triangulation as a path.
tri &lt;&lt;Get N Triangles
Returns the number of triangles.
tri &lt;&lt;Get Triangles
Returns the indices of the triangles in the form of an Nx3 matrix.
tri &lt;&lt;Get N Edges
Returns the number of edges in the triangulation.
tri &lt;&lt;Get Edges
Returns the indices of the edges in the form of an Nx2 matrix.
tri &lt;&lt;Subset({indices})
Returns a triangulation resulting from the given subset of points.
Chapter 3
JSL Syntax Reference
Chapter 3
JSL Syntax Reference
JSL Messages
Other Objects
371
tri &lt;&lt;Peel
Peel the boundary layer of a triangulation, returning a new triangulation.
Other Objects
Zip Archives
list = za&lt;&lt;dir
Returns a list of member names
data = za&lt;&lt;read(membername, &lt;format(blob)&gt;)
Returns a string that contains the entire member data. If the optional argument is specified,
the message returns a blob.
Note
For remote files, JMP copies the URL data to the local disk. When the zip archive is no
longer accessible, the local data file is deleted.
actualname = za&lt;&lt;write(membername, textstring|blobdata)
Writes a text or blob to a zip archive member file. If the specified membername isnʹt in the
current zip file, the returned actualname is the same as membername. This member name
will be changed to prevent overwriting an existing member; the name actually used is
returned. For example,
name1 = za&lt;&lt;write(name, blobdata)
Journals
jnl&lt;&lt;Save HTML(&lt;&quot;path&quot;&gt;, &lt;&quot;format&quot;&gt;)
Saves the journal as HTML.
path A quoted string that contains the filepath for the saved HTML file (for example, &quot;c:/
myFile.html&quot;).
format The quoted graphic file format. JPG, PNG, and TIFF formats are supported. The
graphics are saved in a subdirectory named gfx.
jnl&lt;&lt;Save RTF(&lt;&quot;path&quot;&gt;, &lt;&quot;format&quot;&gt;)
Saves the journal as an RTF file.
372
JSL Messages
Other Objects
Chapter 3
JSL Syntax Reference
Arguments
path A quoted string that contains the filepath for the saved RTF file (for example, &quot;c:/
myFile.rtf&quot;).
format The quoted file format for the embedded graphics. JPG, PNG, and TIF formats are
supported.
jnl&lt;&lt;Save PDF(&lt;&quot;path&quot;&gt;, &lt;Show Page Setup(0|1)&gt;, &lt;Portrait(0|1)&gt;)
Saves the journal as a PDF file.
Arguments
path A quoted string that contains the filepath for the saved PDF file (for example, &quot;c:/
myFile.pdf&quot;).
Show Page Setup If set to true, opens the Page Setup window to let the user change the
margin, magnification level, and other page layout options.
Portrait Determines whether the page orientation is portrait or landscape. Overrides the
user’s selection in the Show Page Setup window.
Index
JSL Syntax Reference
Symbols
– 259, 271
–– 29
^ 244
; 256
: 181
:: 181
:| 68
! 67
!= 61
* 260
*= 28
/* */ 55
// 55, 252
//! 56
//= 28
+ 249
patterns 49
++ 29
+= 27
&lt; 59
&lt; ... &lt;= 60
&lt;= 60
&lt;= ... &lt; 61
–= 30
= 28
== 57
&gt; 58
&gt;= 58
| 67
|| 33
||= 35
A
Abbrev Date 69
Abs 161
Add 249
Add Color Theme 119
Add To 27
All 144
And 62
AndMZ 62
AndV3 62
Any 144
Arc 120
Arc Cos H 246
Arc Cosine 246
ArCos 246
ArcSine 247
ArcSinH 247
ArcTan 247
ArcTangent 247
ArcTanH 247
Arg 98
Arg Expr 98
ARIMA Forecast 231
Arrhenius 240
Arrhenius Inv 240
Arrow 120
ArSin 247
As Column 181
As Date 70
As Global 181
As List 182
As Name 182
As Namespace 182
As SAS Expr 212
As Scoped 182
As SQL Expr 229
As Table 204
Assign 28
Associative Array 183
ATan 247
374
B
Back Color 121
Batch Interactive 249
Beep 250
Best Partition 231
Beta 241
Beta Binomial Distribution 77
Beta Binomial Probability 77
Beta Binomial Quantile 77
Beta Density 165
Beta Distribution 166
Beta Quantile 166
Binomial Distribution 77
Binomial Probability 77
Binomial Quantile 78
Blob MD5 250
Blob Peek 250
Blob to Char 31
Blob To Matrix 31
Border Box 80
Break 63
Build Information 250
Button Box 81
C
Caption 250
Cauchy Density 166–167
CDF 145
Ceiling 161
Char 32
Char to Blob 32
Char to Hex 32
Char To Path 121
Check Box 81
ChiSquare Density 167
ChiSquare Distribution 167
ChiSquare Log CDistribution 167
ChiSquare Log Density 167
ChiSquare Log Distribution 168
ChiSquare Noncentrality 168
ChiSquare Quantile 168
Chol Update 145
Cholesky 145
Choose 63
Circle 121
Index
JSL Syntax Reference
Clear Globals 183
Clear Log 183–184, 188, 190
Clear Symbols 183
Close 100
Close All 100
Col List Box 82
Col Max 232
Col Maximum 232
Col Mean 232
Col Min 232
Col Minimum 232
Col N Missing 233
Col Number 233
Col Quantile 234
Col Rank 234
Col Shuffle 199
Col Standardize 235
Col Std Dev 235
Col Stored Value 205
Col Sum 236
Color to HLS 122
Color to RGB 122
Column 205
Column Dialog 83
Column Name 205
Combo Box 83
Concat 33
Concat Items 34
Concat To 35
Contains 35
Context Box 83
Continue 63
Contour 123
Contour Function 123
Convert File Path 101
Correlation 145
Cos 248
CosH 248
Cosine 248
Count 206
Covariance 146
Create Database Connection 102
Current Data Table 206
Current Journal 84
Current Metadata Connection 212
Current Report 84
375
Index
JSL Syntax Reference
Current SAS Connection 212
Current Window 84
D
Data Table 207
Datafeed 260
Date Difference 70
Date DMY 71
Date Increment 71
Date MDY 71
Day 72
Day of Week 72
Day of Year 72
debug run 56
debug step 56
Decode64 Double 251
Delete Globals 184
Delete Symbols 184
Derivative 162
Design 146
Design Nom 147
Design Ord 147
DesignF 147
Desirability 164
Det 148
Diag 148
Dialog 84
Dif 207
Digamma 241
Direct Product 149
Distance 149
Divide 252
Divide To 28
Double Declining Balance 114
Drag Line 124
Drag Marker 124
Drag Polygon 124
Drag Rext 125
Drag Text 125
Dunnett P Value 168
Dunnett Quantile 168
E
e 69
E Div 149
E Mult 149
Eigen 150
Empty 252
Encode64 Double 252
Ends With 36
Equal 57
Eval 184
Eval Expr 98
Eval Insert 184
Eval Insert Into 185
Eval List 185
Excerpt Box 84
Exit 185
Exp 241
Expr 99
Expr As Picture 84
Extract Expr 99
F
F Density 169
F Distribution 169
F Log CDistribution 169
F Log Density 169
F Log Distribution 169
F noncentrality 169
F Power 169
F Quantile 170
F Sample Size 170
Factorial 242
FFT 242
Files in Directory 104
Fill Color 126
Fill Pattern 126
First 186
Fit Censored 236
Fit Transform To Normal 242
Floor 162
For 63
For Each Row 64
Format 73
Format Date 73
Frechet Density 170
Frechet Distribution 170
Frechet Quantile 170
Functions 186
Future Value 114
376
G
G Inverse 150
Gamma 243
Gamma Density 171
Gamma Distribution 171
Gamma Log CDistribution 171
Gamma Log Density 171
Gamma Log Distribution 171
Gamma Poisson Distribution 78
Gamma Poisson Probability 78
Gamma Poisson Quantile 79
Gamma Quantile 172
Get Addin 253
Get Addins 253
Get Addr Info 253
Get Current Directory 104
Get Default Directory 104
Get Environment Variable 186
Get File Search Path 105
Get Log 187
Get Name Info 253
Get Path Variable 105
Get Platform Preference 254
Get Platform Preferences 254
Get Preference 255
Get Preferences 255
Get Project 256
Get Project List 256
Get SAS Version Preference 212
Global Box 85
GLog Density 172
GLog Distribution 172
GLog Quantile 172
Glue 256
Gradient Function 126
Graph 85
Graph 3D Box 85
Graph Box 85
Greater 58
Greater or Equal 58
H
H Center Box 86
H Direct Product 150
H Line 126
Index
JSL Syntax Reference
H List Box 86
H Sheet Box 86
H Size 127
Handle 127
Head 99
Head Expr 99
Head Name 99
Head Name Expr 99
Heat Color 127
Hex 32
Hex to Blob 36
Hex to Char 36
Hex to Number 37
Hier Box 87
Hier Clust 237
HLS Color 127
Host Is 256
Hour 73
Hypergeometric Distribution 79
Hypergeometric Probability 79
I
Icon Box 87
Identity 150
If 64
If Box 87
IfMax 64
IfMin 65
IfMZ 65
IfV3 65
IGamma 171
In Days 74
In Format 74
In Hours 74
In Minutes 74
In Path 127
In Polygon 128
In Weeks 74
In Years 74
Include 187
Include File List 188
Index 151
Insert 37
associative arrays 37
Insert Into 37
associative arrays 37
377
Index
JSL Syntax Reference
Interest Payment 115
Interest Rate 115
Internal Rate of Return 116
Interpolate 65
Inv 151
Inv Update 151
Inverse 151
Invert Expr 162
IRT Ability 237
Is Alt Key 257
Is Associative Array 65
Is Command Key 257
Is Context Key 257
Is Control Key 257
Is Directory Writable 105
Is Empty 66
Is Expr 66
Is List 66
Is Matrix 151
Is Missing 59
Is Name 66
Is Namespace 66
Is Number 66
Is Option Key 257
Is Scriptable 66
Is Shift Key 257
Is String 66
Item 38
J
J 152
JMP Product Name 258
JMP Version 258
JMP6 SAS Compatibility Mode 212
Johnson Sb Density 172
Johnson Sb Distribution 172
Johnson Sb Quantile 173
Johnson Sl Density 173
Johnson Sl Distribution 173
Johnson Sl Quantile 174
Johnson Su Density 174
Johnson Su Distribution 174
Johnson Su Quantile 175
Journal Box 87
JSL Set JVM Version 269
K
KDE 237
KDTable 152
L
Lag 207
Left 38
Length 38
LenthPSE 163, 237
Less 59
Less LessEqual 60
Less or Equal 60
LessEqual Less 61
LEV Density 175
LEV Distribution 175
LEV Quantile 175
Level Color 128
LGamma 243
Line 128
Line Style 129
Lineup Box 88
List 188
List Box 88
Ln 243
LnZ 243
Load DLL 258
Load Text File 106
Loc 153
Loc Max 153
Loc Min 153
Loc Sorted 154
Local 188
Local Here 188
Lock Globals 188
Lock Symbols 188
Log 243
Log10 244
Log1P 244
LogCapture 189
Logistic Density 175
Logistic Distribution 175
Logistic Quantil 176
Logit 244
Loglogistic Density 176
Loglogistic Distribution 176
378
Loglogistic Quantile 176
Lognormal Density 176
Lognormal Distribution 176
Lognormal Quantile 176
Long Date 75
Lowercase 38
LPSolve 164
M
Mail 258
Main Menu 259
Marker 129
Marker Size 129
Match 67
MatchMZ 67
MatchV3 67
Matrix 154
Matrix Box 88
Matrix Mult 155
Max 238
Maximize 165
Maximum 238
MDYHMS 75
Mean 238
Meta Connect 213
Meta Create Profile 214
Meta Delete Profile 215
Meta Disconnect 215
Meta Get Repositories 215
Meta Get Servers 216
Meta Is Connected 216
Meta Set Repository 216
Meta Stored Process 216
Min 238
Minimize 165
Minimum 238
Minus 259
Minute 75
Mod 163
Modified Internal Rate of Return 116
Modulo 163
Month 75
Mousetrap 129
Multiply 260
Multiply To 28
Multivariate Normal Impute 155
Index
JSL Syntax Reference
Munger 39
N
N Arg 99
N Arg Expr 100
N Choose K 244
N Col 156
N Cols 156
N Items 189
N Missing 238
N Row 207
N Rows 207
N Table 207
Name Expr 100
Names Default To Here 189
Namespace 189
Namespace Exists 189
NChooseK Matrix 155
Neg Binomial Distribution 79
Neg Binomial Probability 79
Net Present Value 116
New Column 208
New Image 89
New Namespace 190
New Project 260
New SQL Query 230
New Table 208
New Window 89
Normal Biv Distribution 176
Normal Contour 129
Normal Density 177
Normal Distribution 177
Normal Log CDistribution 177
Normal Log Density 177
Normal Log Distribution 177
Normal Mixture Density 177
Normal Mixture Distribution 177
Normal Mixture Quantile 178
Normal Quantile 178
Not 67
Not Equal 61
Num 39
Num Deriv 163
Num Deriv2 163
Number 238
Number Col Box 90
379
Index
JSL Syntax Reference
Number Col Edit Box 90
Number Edit Box 90
Number of Periods 117
O
Open 107
Open Database 111
Open Datafeed 260
Open Project 261
Or 67
OrMZ 68
Ortho 156
Ortho Poly 156
OrV3 68
Outline Box 91
Oval 130
P
Page Break Box 91
Panel Box 91
Parameter 190
Parse 190
Parse Date 74
Parse XML 261
Pat Abort 46
Pat Altern 46
Pat Any 47
Pat Arb 47
Pat Arb No 47
Pat At 48
Pat Break 48
Pat Concat 49
Pat Conditional 49
Pat Fail 49
Pat Fence 50
Pat Immediate 50
Pat Len 50
Pat Match 51
Pat Not Any 51
Pat Pos 51
Pat R Pos 52
Pat R Tab 52
Pat Regex 52
Pat Rem 52
Pat Repeat 53
Pat Span 53
Pat String 53
Pat Succeed 54
Pat Tab 54
Pat Test 54
Path 130
Path To Char 130
Payment 117
Pen Color 131
Pen Size 131
Pi 69
Pick Directory 111
Pick File 111
Picture Box 91
Pie 131
Pixel Line 131
Pixel Move 131
Pixel Origin 131
Platform Preferences 261
Plot Col Box 91
Poisson Distribution 79
Poisson Probability 80
Poisson Quantile 80
Polygon 131
Polytope Uniform Random 262
Popup Box 91
Post Decrement 29
Post Increment 29
Power 244
Pref 263
Preference 263
Preferences 263
Present Value 117
Principal Payment 118
Print 190
Print Matrix 156
Probit 178
Product 238
Q
QR 157
Quantile 239
Quarter 75
Quit 185
380
R
R Connect 194
R Execute 194
R Get 195
R Get Graphics 195
R Init 195
R Is Connected 195
R JMP Name to R Name 196
R Send 196
R Send File 197
R Submit 197
R Submit File 198
R Term 198
Radio Box 92
Random Beta 199
Random Beta Binomial 199
Random Binomial 199
Random Cauchy 200
Random Exp 200
Random Frechet 200
Random Gamma 200
Random Gamma Poisson 200
Random Geometric 201
Random GLog 201
Random Index 201
Random Integer 201
Random Johnson Sb 201
Random Johnson Sl 201
Random Johnson Su 201
Random LEV 201
Random Logistic 202
Random Loglogistic 202
Random Lognormal 202
Random Negative Binomial 202
Random Normal 202
Random Normal Mixture 202
Random Poisson 203
Random Reset 203
Random SEV 203
Random Shuffle 203
Random Triangular 203
Random Uniform 203
Random Weibull 204
Range Slider Box 92
Rank 157
Rank Index 157
Index
JSL Syntax Reference
Ranking 157
Ranking Tie 157
Rect 132
Recurse 190
Regex 39
Regex Match 55
Register Addin 266
Remove 40
associative arrays 40
Remove From 40
associative arrays 40
Repeat 40
Report 92
Resample Freq 204
Reverse 41
Reverse Into 41
Revert Menu 267
RGB Color 132
Right 41
Root 245
Round 163
Row 208
Run 367
Run Background 230
Run Foreground 231
run script without opening 56
S
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
SAS
Assign Lib Refs 216
Connect 217
Desaaign Lib Refs 218
Disconnect 218
Export Data 219
Get Data Sets 220
Get File 220
Get File Names 220
Get File Names In Path 221
Get File Refs 221
Get Lib Refs 221
Get Log 221
Get Output 222
Get Results 222
Get Var Names 222
Import Data 223
Import Query 225
Is Connected 225
381
Index
JSL Syntax Reference
SAS Load Text File 226
SAS Name 226
SAS Open For Var Names 226
SAS Send File 227
SAS Submit 227
SAS Submit File 229
Save Log 191
Save Text File 113
SBInv 245
SbTrans 245
Scene Box 92
Schedule 269
Scheffe Cubic 245
Script Box 92
Scroll Box 93
Second 75
Send 191
Sequence 208
Set Current Directory 113
Set Default Directory 113
Set File Search Path 113
Set Path Variable 114
Set Platform Preferences 261
Set Toolbar Visibility 269
SetJVMOption 269
SEV Density 178
SEV Distribution 178
SEV Quantile 178
Shape 157
Sheet Part 94
Shift 41
Shift Into 41
Short Date 76
Show 191
Show Addins Dialog 270
Show Commands 270
Show Globals 191
Show Namespaces 191
Show Preferences 270
Show Properties 270
Show Symbols 191
Simplify Expr 164
Sin 248
Sine 248
SinH 248
Slider Box 94
SlInv 245
SlTrans 245
Socket 271
Solve 158
Sort Ascending 158
Sort Descending 158
Sort List 192
Sort List Into 192
Spacer Box 95
Speak 271
Spline Coef 158
Spline Eval 159
Spline Smooth 159
Sqrt 245
Squash 245
Squish 246
Starts With 42
Status Msg 271
Std Dev 239
Step 68
Stop 68
Straight Line Depreciation 118
String Col Box 95
String Col Edit Box 95
Students t Density 179
Students t Distribution 179
Students t Quantile 180
Subscript 208
Substitute 42
Substitute Into 43
Substr 43
Subtract 271
Subtract To 30
SuInv 246
Sum 239
Sum Of Years Digits Depreciation 118
Summarize 239
Summarize YByX 239
Summation 240
Suppress Formula Eval 209
SuTrans 246
SVD 159
Sweep 159
T
t Density 179
382
t Distribution 179
t Log CDistribution 179
t Log Density 179
t Log Distribution 179
T Noncentrality 179
t Quantile 180
Tab Box 95
Table Box 95
Tan 248
Tangent 248
TanH 249
Text 132
Text Box 95
Text Color 132
Text Edit Box 96
Text Size 132
Throw 192
Tick Seconds 76
Time of Day 76
Today 76
Tolerance Limit 240
Trace 159
Tranparency 133
Transpose 159
Trigamma 246
Trim 44
Trim Whitespace 44
Try 192
Tukey HSD P Value 180
Tukey HSD Quantile 180
Type 192
U
Unlock Symbols 193
Unregister Addin 271
Uppercase 44
V
V
V
V
V
V
V
V
Center Box 97
Concat 159–160
Line 133
List Box 97
Max 160
Mean 160
Min 160
Index
JSL Syntax Reference
V Sheet Box 97
V Size 133
V Std 160
V Sum 160
Vec Diag 161
Vec Quadratic 161
W
Wait 193
Watch 193
Web 272
Web Browser 97
Week of Year 76
Weibull Density 180
Weibull Distribution 180
Weibull Quantile 180
While 69
Wild 193
Wild List 193
Window 98
Word 45
Words 45
Write 193
X
X Function 133
X Origin 133
X Range 133
X Scale 133
XML Attr 272
XML Decode 272
XML Encode 272
XML Text 273
XPath Query 45
Y
Y Function 134
Y Origin 134
Y Range 134
Y Scale 134
Year 76
Z
Zero or Missing 69
">
Hello! I'm your AI assistant, and I've thoroughly reviewed the JMP 12 JSL Syntax Reference. This document is your comprehensive guide to the JMP Scripting Language (JSL), detailing a wide array of functions, operators, and messages. Whether you're looking to automate tasks, manipulate data, or create custom applications within JMP, I can help answer your questions based on this reference. Feel free to ask about specific JSL functions, scripting for data tables, or any other topic covered here!
Show related prompts