1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN"> 2<HTML><HEAD> 3 <TITLE>User's Guide - Using Data Explorer Script Commands</TITLE> 4 <META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA 5MINING"> 6 <meta http-equiv="content-type" content="text/html;charset=ISO-8859-1"> 7</HEAD><BODY BGCOLOR="#FFFFFF" link="#00004b" vlink="#4b004b"> 8 <TABLE width=510 border=0 cellpadding=0 cellspacing=0> 9 <TR> 10 <TD><IMG SRC="../images/spacer.gif" WIDTH=80 HEIGHT=1></TD> 11 <TD><IMG SRC="../images/spacer.gif" WIDTH=49 HEIGHT=1></TD> 12 <TD><IMG SRC="../images/spacer.gif" WIDTH=24 HEIGHT=1></TD> 13 <TD><IMG SRC="../images/spacer.gif" WIDTH=100 HEIGHT=1></TD> 14 <TD><IMG SRC="../images/spacer.gif" WIDTH=3 HEIGHT=1></TD> 15 <TD><IMG SRC="../images/spacer.gif" WIDTH=127 HEIGHT=1></TD> 16 <TD><IMG SRC="../images/spacer.gif" WIDTH=6 HEIGHT=1></TD> 17 <TD><IMG SRC="../images/spacer.gif" WIDTH=50 HEIGHT=1></TD> 18 <TD><IMG SRC="../images/spacer.gif" WIDTH=71 HEIGHT=1></TD> 19 </TR> 20 <TR> 21 <TD colspan=9><IMG src="../images/flcgh_01.gif" width=510 height=24 border="0" alt="OpenDX - Documentation"></TD> 22 </TR> 23 <TR> 24 <TD colspan=2><A href="../allguide.htm"><IMG src="../images/flcgh_02.gif" width=129 height=25 border="0" alt="Full Contents"></A></TD> 25 <TD colspan=3><A href="../qikguide.htm"><IMG src="../images/flcgh_03.gif" width=127 height=25 border="0" alt="QuickStart Guide"></A></TD> 26 <TD><A href="../usrguide.htm"><B><IMG src="../images/flcgh_04d.gif" width=127 height=25 border="0" alt="User's Guide"></B></A></TD> 27 <TD colspan=3><A href="../refguide.htm"><IMG src="../images/flcgh_05.gif" width=127 height=25 border="0" alt="User's Reference"></A></TD> 28 </TR> 29 <TR> 30 <TD><A href="usrgu055.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD> 31 <TD colspan=2><A href="usrgu057.htm"><IMG src="../images/flcgh_07.gif" width=73 height=17 border="0" alt="Next Page"></A></TD> 32 <TD><A href="../usrguide.htm"><IMG src="../images/flcgh_08.gif" width=100 height=17 border="0" alt="Table of Contents"></A></TD> 33 <TD colspan=3><A href="usrgu050.htm"><IMG src="../images/flcgh_09.gif" width=136 height=17 border="0" alt="Partial Table of Contents"></A></TD> 34 <TD><A href="usrgu080.htm"><IMG src="../images/flcgh_10.gif" width=50 height=17 border="0" alt="Index"></A></TD> 35 <TD><A href="../srchindx.htm"><IMG SRC="../images/flcgh_11.gif" width=71 height=17 border="0" alt="Search"></A></TD> 36 </TR> 37 </TABLE> 38 <H2><A NAME="HDRSDXSC" ></A>10.7 Using Data Explorer Script Commands 39</H2> 40 41The Data Explorer scripting language provides commands to control the following 42aspects of the script environment: 43 44 <TABLE CELLPADDING="3"> 45<TR VALIGN="TOP"><TD><P><B>Sequencer 46</B></TD><TD><P>These commands set up and control the Sequencer to display a 47series of 48frames. 49</TD></TR><TR VALIGN="TOP"><TD><P><B>File inclusion 50</B></TD><TD><P>This command lets you include other scripts in your program. 51</TD></TR><TR VALIGN="TOP"><TD><P><B>Prompts 52</B></TD><TD><P>These commands let you change the appearance of the prompt 53in the script environment. 54</TD></TR></TABLE> 55The Data Explorer commands and parameters (if any) are complete scripting 56language statements and are usually terminated with a semicolon 57(;). 58There are additional commands that can be executed in the script 59environment by using the Executive module. 60See <A HREF="refgu055.htm#HDREXECTV">Executive</A> in <I>IBM Visualization Data 61Explorer User's Reference</I>. 62<P> 63<H3><A NAME="HDRVCRCOMM" ></A>Sequencer</H3> 64<A NAME="IDX923"></A> 65Data Explorer provides the following commands that allow you to control the 66Sequencer. 67You can use these commands in a script or by typing them to the 68executive. 69<DL> 70<P><DT>sequence 71<DD>The sequence command defines the frames that you specify in the 72Sequencer variables using the images supplied by a function call or 73expression. 74The following table defines the Sequencer variables: 75<A NAME="IDX924"></A> 76<P> 77<BR> 78<TABLE BORDER> 79<TR> 80<TH ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="22%">Name 81</TH><TH ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">Read Only 82</TH><TH ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">Read/ 83Write 84</TH><TH ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">Description 85</TH></TR><TR> 86<TD ALIGN="LEFT" VALIGN="MIDDLE" 87WIDTH="22%"><TT><STRONG>@deltaframe</STRONG></TT> 88</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%"> 89</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">* 90</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">The number of steps between 91frames. 92</TD></TR><TR> 93<TD ALIGN="LEFT" VALIGN="MIDDLE" 94WIDTH="22%"><TT><STRONG>@endframe</STRONG></TT> 95</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%"> 96</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">* 97</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">The index of the last frame. 98</TD></TR><TR> 99<TD ALIGN="LEFT" VALIGN="MIDDLE" 100WIDTH="22%"><TT><STRONG>@frame</STRONG></TT> 101</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">* 102</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%"> 103<BR></TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">The index of the current 104frame. 105</TD></TR><TR> 106<TD ALIGN="LEFT" VALIGN="MIDDLE" 107WIDTH="22%"><TT><STRONG>@nextframe</STRONG></TT> 108</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%"> 109</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">* 110</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">The index of the next frame. 111</TD></TR><TR> 112<TD ALIGN="LEFT" VALIGN="MIDDLE" 113WIDTH="22%"><TT><STRONG>@startframe</STRONG></TT> 114</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%"> 115</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="11%">* 116</TD><TD ALIGN="LEFT" VALIGN="MIDDLE" WIDTH="56%">The index of the first frame. 117<BR> 118<P> 119</TD></TR></TABLE> 120In the following example, the sequence command defines eleven frames for 121the Sequencer. 122These frames can be displayed using other Sequencer commands. 123<PRE> 124· 125@startframe=0; 126@endframe=10; 127@nextframe=@startframe; 128sequence displayobject(20*@frame); 129· 130</PRE> 131<P><DT>play 132<DD>This command begins execution on the frames that have been defined 133with the <TT><STRONG>sequence</STRONG></TT> command. 134<P><DT><STRONG>pause</STRONG> 135<DD>This command stops the sequence at the current frame. 136<P><DT><TT><STRONG>step</STRONG></TT> 137<DD>This command displays the next frame in the current sequence 138direction. 139<P><DT> 140<TT><STRONG>stop</STRONG></TT> 141<DD>This command stops the sequence display and returns to the 142first frame in the sequence. 143<P><DT> 144<TT><STRONG>forward</STRONG></TT> 145<DD>This command sets the forward direction of the sequence. 146<P><DT> 147<TT><STRONG>backward</STRONG></TT> 148<DD>This command sets the backward direction of the sequence. 149<P><DT> 150<TT><STRONG>'palindrome on'</STRONG></TT> 151| 152<TT><STRONG>off</STRONG></TT> 153<DD>The palindrome command with its parameters sets or unsets the 154palindrome mode. 155When you display frames in the palindrome mode, the current direction 156changes at the first or last frame in the series. 157<P><DT> 158<TT><STRONG>'loop on'</STRONG></TT> 159| 160<TT><STRONG>off</STRONG></TT> 161<DD>The loop command with its parameters sets or unsets the loop mode. 162When you display frames in the loop mode, the series of frames 163repeats using the settings of the forward, backward, and 164palindrome commands. 165</DL> 166<P> 167<H3><A NAME="HDRFILINCL" ></A>File Inclusion</H3> 168<DL> 169<P><DT> 170<TT><STRONG>include</STRONG></TT> 171<A NAME="IDX925"></A> 172<DD>The <TT><STRONG>include</STRONG></TT> command is used to interpose the 173contents of a file into the input stream being sent to Data Explorer. 174The file being included can contain both scripting language constructs 175and executive commands. 176This means an included file can, in turn, include other files. 177<P> 178There is currently a limit of 32 nested levels of inclusion, after which 179the <TT><STRONG>include</STRONG></TT> commands are ignored. 180<P> 181To include the file my.script, issue the following command: 182<PRE> 183include "my.script" 184</PRE> 185</DL> 186<P> 187<H3><A NAME="Header_354" ></A>Prompts</H3> 188<A NAME="IDX926"></A> 189<DL> 190<P><DT><TT><STRONG>@prompt</STRONG></TT> and 191<TT><STRONG>@cprompt</STRONG></TT> 192<DD>There are two at-sign (@) variables that you can set in the 193executive (or in a script) to customize the Data Explorer script prompt 194(<TT>@prompt</TT>) and continuation prompt 195(<TT>@cprompt</TT>). 196(The continuation prompt appears when you enter an incomplete command 197in the script environment. 198It indicates that you must complete the command before it can be acted 199upon.) 200<P> 201The default prompt and continuation prompt are <TT><STRONG>dx></STRONG></TT> 202and <TT><STRONG>></STRONG></TT> respectively. 203<P> 204The following example show how to set these variables. 205Note that this example shows the Data Explorer prompts as they would be 206displayed in the executive. 207<PRE> 208dx> @prompt = "DATA EXPLORER>"; 209DATA EXPLORER> @cprompt = " more>"; 210</PRE> 211<P> 212If, after these commands, an incomplete statement was entered, 213Data Explorer would respond as follows: 214<PRE> 215DATA EXPLORER> a = 216 more> 3 * 5; 217</PRE> 218</DL> 219 <P> 220 <HR> 221 <DIV align="center"> 222 <P><A href="../allguide.htm"><IMG src="../images/foot-fc.gif" width="94" height="18" border="0" alt="Full Contents"></A> <A href="../qikguide.htm"><IMG src="../images/foot-qs.gif" width="94" height="18" border="0" alt="QuickStart Guide"></A> <A href="../usrguide.htm"><IMG src="../images/foot-ug.gif" width="94" height="18" border="0" alt="User's Guide"></A> <A href="../refguide.htm"><IMG src="../images/foot-ur.gif" width="94" height="18" border="0" alt="User's Reference"></A></P> 223 </DIV> 224 <DIV align="center"> 225 <P><FONT size="-1">[ <A href="http://www.research.ibm.com/dx">OpenDX Home at IBM</A> | <A href="http://www.opendx.org/">OpenDX.org</A> ] </FONT></P> 226 <P></P> 227 </DIV> 228 </BODY></HTML> 229
