Automation Reference - JMP

More documents

Recommendations

Info

Application Object Reference for Automating JMP Common Analysis Functions Common Analysis Functions Each analysis and graphing platform shares a common set of functions. So, regardless of what analysis you are running you can call these methods. Methods You can use all of the Common Analysis methods with any analysis or graph platform. CreateJournal() As Journal Creates a journal and returns a pointer to the automation object the represents it. This object can then be used to save output to disk. CopyGraphicItem(Handle As Long) As Boolean Copies a metafile representation of the graphic sub-item identified by handle to the clipboard. DisplayBoxAppend(SrcHandle as Long, AppendHandle as Long) As Long Adds a display box to the end of another display box. DisplayBoxPrepend(SrcHandle as Long, AppendHandle as Long) As Long Adds a display box before another display box. FrameBoxAddGraphicsScript(long handle, script As String) As Boolean Associates a graphics script with a FrameBox, given its handle (returned from GetGraphicItemByType). This is just like the interactive dialog to add a graphics script to an analysis frame. The method returns True if it is successful, or False if there is a failure. FrameBoxSetBackColor(long handle, jmpColorConstants color) As Boolean Sets the background color within a FrameBox given its handle (returned from GetGraphicItemByType). The jmpColorConstants define the range of colors. The method returns True if it is successful, or False if there is a failure. FrameBoxSetMarkerSize(long handle, frameMarkerSizes size) As Boolean Sets the size of the markers within a Frame Box, given its handle (returned from GetGraphicItemByType). The frameMarkerSizes constants define the range of sizes. The method returns True if it is successful, or False if there is a failure. FrameBoxTransparency(alpha as Double) As Boolean Sets the transparency level of the points within the graph. GetGraphicItemByName(ItemName as String) As Long Returns a handle to a JMP display sub-item. An example of a sub-item would be the “Analysis of Variance” results table from a Bivariate analysis. This handle can be used be other operations described below. Page 48
Application Object Reference for Automating JMP Common Analysis Functions GetGraphicItemByType(TypeName As String, ItemNumber As Integer) As Long Returns a handle to a JMP display sub-item based on the item type. An example of a sub-item type would be the PictureBox. PictureBox number one might return a handle to an analysis plot. This handle can be used be other operations described below. GetSubgraphicItemByName(Handle as Long, Name as String) As Long Returns a handle to a display box.under the display box referenced by Handle. The display box returned is given by the title of the box. This is similar to the method GetGraphicItemByName(ItemName as String) As Long. The difference is the starting display box. GetGraphicItemByName(ItemName as String) As Long starts at the top of the display while GetSubgraphicItemByName is relative to the display box referenced by handle. GetSubgraphicItemByType(Handle as Long, BoxName as String, BoxNumber as Short) As Long Returns a handle to a display box under the display box referenced by Handle. The display returned is given by the box type and the number. This is similar to the method GetGraphicItemByType(TypeName As String, ItemNumber As Integer) As Long. The difference is the starting display box. GetGraphicItemByType(TypeName As String, ItemNumber As Integer) As Long starts at the top of the display while GetSubgraphicItemByType is relative to the display box referenced by handle. GetTextOfGraphicItem(Handle As Long) As String Copies the entire text of a graphic sub-item into a string. This will only work for relevant sub-items, like TableBoxes, TextBoxes, NumberColBoxes, and so forth. JournalGraphicItem(Handle As Long) As Boolean Copies the graphic sub-item to a JMP journal. JournalOutput() As Boolean Creates a journal for the current analysis window, without returning an automation object that allows further manipulation. Launch() As Boolean Runs the analysis with the columns that have been specified through LaunchAdd___. LaunchAdd___(ColumnName As String) As Boolean Adds the column name to the given role, where ___ should be X, Y, Freq, etc. (LaunchAddX for the X role, LaunchAddFreq for the Freq role, etc.). You must add columns before executing the Launch routine, otherwise the analysis will not know the source of the data. LaunchAddBy() As Boolean Adds the column name to be used for By Group processing. By default, when an analysis is launched, the functions specific to that analysis or graph will work on the first By Group result. Returns True if successful, False if unsuccessful. Page 49
Page 1 and 2:
Version 10 Automation Reference JMP
Page 3 and 4:
Application Object Reference for Au
Page 5 and 6:
Contents Application Object Referen
Page 7 and 8:
Page 9 and 10:
Page 11 and 12:
Page 13 and 14:
Page 15 and 16:
Page 17 and 18: Contents Application Object Referen
Page 19 and 20: Contents Application Object Referen
Page 21 and 22: Application Object Reference for Au
Page 67: Application Object Reference for Au
Page 119 and 120:
Page 121 and 122:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Page 129 and 130:
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Index Application Object Reference
Page 149 and 150:
Page 151 and 152:
Page 153 and 154:
Page 155 and 156:
Page 157:
show all

Automation Reference - JMP

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?