Automation Reference - JMP

More documents

Recommendations

Info

Application Object Reference for Automating JMP Column Object NumDecPlaces Integer property that indicates the number of decimal places that are allowed for a numeric column. For retrieval only. Methods AddFormula(JSLText As String) Adds a formula to the column, given a valid formula specified using JSL. AddValueLabelToList(Value as String, Label as String) As Boolean Adds a value label to an automation list. The value label will not be assigned to the column until CommitValueLabels() As Boolean is called. In this way, several value labels can be accumulated for the column before they are assigned. Returns True for success, False for failure. See also CommitValueLabels() As Boolean and RemoveValueLabels() As Boolean. An example of using these methods in a Visual Basic application is: ’ Using the data table "Big Class.jmp" already assigned in object DT Dim ColSex As JMP.Column Dim ColAge As JMP.Column Set ColSex = DT.GetColumn("sex") Set ColAge = DT.GetColumn("age") ColSex.AddValueLabelToList "M", "Male" ColSex.AddValueLabelToList "F", "Female" ColSex.CommitValueLabels ColAge.AddValueLabelToList "12", "Twelve" ColAge.AddValueLabelToList "13", "Thirteen" ColAge.AddValueLabelToList "14", "Fourteen" ColAge.AddValueLabelToList "15", "Fifteen" ColAge.AddValueLabelToList "16", "Sixteen" ColAge.AddValueLabelToList "17", "Seventeen" ColAge.CommitValueLabels CommitValueLabels() As Boolean Commits (adds) all the value labels to the columns that were previously assigned using AddValueLabelToList(Value as String, Label as String) As Boolean. After CommitValueLabels is called, the column will update with the new labels. Returns True for success, False for failure. See also AddValueLabelToList(Value as String, Label as String) As Boolean and RemoveValueLabels() As Boolean. An example of using these methods in a Visual Basic application is: ’ Using the data table "Big Class.jmp" already assigned in object DT Dim ColSex As JMP.Column Dim ColAge As JMP.Column Set ColSex = DT.GetColumn("sex") Set ColAge = DT.GetColumn("age") Page 44
Application Object Reference for Automating JMP Column Object ColSex.AddValueLabelToList "M", "Male" ColSex.AddValueLabelToList "F", "Female" ColSex.CommitValueLabels ColAge.AddValueLabelToList "12", "Twelve" ColAge.AddValueLabelToList "13", "Thirteen" ColAge.AddValueLabelToList "14", "Fourteen" ColAge.AddValueLabelToList "15", "Fifteen" ColAge.AddValueLabelToList "16", "Sixteen" ColAge.AddValueLabelToList "17", "Seventeen" ColAge.CommitValueLabels Exclude() As Boolean Excludes the column. This operation is a toggle, meaning that calling them once sets them and calling them a second time unsets them. A return value of True indicates success, False indicates failure. GetCellVal(RowNumber As Integer) As String Returns the value of a given row of the column as a string. If the value is really a numeric, any conversion must be done by the caller. Visual Basic can do this automatically if the receiving object is defined as a numeric. GetDataSource() As Integer Attempts to find out of the column is regular data, instrument data, or contains a formula. It returns an integer that is part of the colDataSourceConstants definition. GetDataVector() As Variant Retrieves a vector with all the elements of a column, passed as a Variant. An example of using GetDataVector in Visual Basic is: ’Get All the names from the "Name" column. Show the first 5 in a ’messagebox Dim Col As JMP.Column Set Col = DT.GetColumn("name") nameArray = Col.GetDataVector For i = 0 To 4 MsgBox (nameArray(i)) Next i GetFormula() As String Retrieves the formula for the column in the form of a string. GetRowStateVectorData Returns the actual data that matches a rowstate criterion. This provides a one-call way to get the data, rather than using GetRowStateVector and then using the indices in a call to SetCellVal(RowNumber As Integer, Value as String). This provides a potential performance gain as well. The method declarations look like: GetRowStateVectorData(rowStateConstants state) As Variant An example of using GetRowStateVectorData in Visual Basic: Dim Col As JMP.Column Set Col = DT.GetColumn("height") Page 45
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: Contents Application Object Referen
Page 21 and 22: Application Object Reference for Au
Page 63: Application Object Reference for Au
Page 115 and 116:
Page 117 and 118:
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

Create successful ePaper yourself

Delete template?

Save as template?