Python Scripting Guide for IBM SPSS Statistics
Contents
1. Introduction to Python Scripts
Working with Multiple Versions of IBM SPSS Statistics
Class Hierarchy for Scripting Facility
Getting Started with Python Scripts
Getting Started with Autoscripts in Python
Running Python Scripts from Python Programs
2. SpssClient Class
CreateNewServer Method
Exit Method
GetActiveDataDoc Method
GetConfiguredServers Method
GetCurrentDirectory Method
GetCurrentServer Method
GetDataDocuments Method
GetDefaultJCVersion Method
GetDefaultServer Method
GetDesignatedOutputDoc Method
GetDesignatedSyntaxDoc Method
GetExportOption Method
GetLocale Method
GetLocalServer Method
GetOutputDocuments Method
GetPreference Method
GetScriptContext Method
GetSPSSOptions Method
GetSPSSPath Method
GetSPSSVersion Method
GetSyntaxDocuments Method
GetUIAlerts Method
IsDataDocInUse Method
IsDistributedMode
IsOptionAvailable Method
LogToViewer Method
NewDataDoc Method
NewOutputDoc Method
NewSyntaxDoc Method
OpenDataDoc Method
OpenOutputDoc Method
OpenSyntaxDoc Method
RunSyntax Method
SaveServers Method
ScriptParameter Method
SetCurrentDirectory Method
SetDefaultJCVersion Method
SetExportOption Method
SetPreference Method
SetUIAlerts Method
StartClient Method
StopClient Method
_heartBeat Method
3. Datasets and Data Editor Windows
SpssDataDoc Class
CloseDocument Method
GetCaseCount Method
GetDatasetName Method
GetDataUI Method
GetDocumentPath Method
GetMenuTable Method
GetVariableCount Method
IsActiveDataDoc Method
IsEqualTo Method
IsModified Method
IsPromptToSave Method
SaveAs Method
SetAsActiveDataDoc Method
SetDatasetName Method
SetModified Method
SetPromptToSave Method
DataDocsList Class
GetItemAt Method
Size Method
SpssDataUI Class
GetHeight Method
GetLeft Method
GetShowGridLines Method
GetShowValueLabels Method
GetTitleText Method
GetTop Method
GetVisible Method
GetWidth Method
GetWindowState Method
InvokeDialog Method
PrintDataDoc Method
SetHeight Method
SetLeft Method
SetShowGridLines Method
SetShowValueLabels Method
SetTop Method
SetVisible Method
SetWidth Method
SetWindowState Method
4. Output Documents and Viewer Windows
SpssOutputDoc Class
ClearSelection Method
CloseDocument Method
Copy Method
CopySpecial Method
CreateHeaderItem Method
CreateImageChartItem Method
CreateTextItem Method
CreateTitleItem Method
Cut Method
Delete Method
Demote Method
ExportCharts Method
ExportDocument Method
GetCurrentItem Method
GetDocumentPath Method
GetFooterText Method
GetHeaderText Method
GetMenuTable Method
GetOutputItems Method
GetOutputOptions Method
GetOutputUI Method
GetPrintOptions Method
InsertTable Method
IsDesignatedOutputDoc Method
IsEqualTo Method
IsModified Method
IsPromptToSave Method
Paste Method
PasteBefore Method
PrintRange Method
Promote Method
SaveAs Method
SelectAll Method
SelectAllCharts Method
SelectAllLogs Method
SelectAllModels Method
SelectAllNotes Method
SelectAllNotesEx Method
SelectAllOther Method
SelectAllTables Method
SelectAllTablesEx Method
SelectAllText Method
SelectAllTitles Method
SelectAllWarnings Method
SelectAllWarningsEx Method
SelectLastOutput Method
SetAsDesignatedOutputDoc Method
SetFooterText Method
SetHeaderText Method
SetModified Method
SetOutputOptions Method
SetPrintOptions Method
SetPromptToSave Method
OutputDocsList Class
GetItemAt Method
Size Method
OutputItemList Class
GetItemAt Method
Size Method
SpssOutputUI Class
GetHeight Method
GetLeft Method
GetSplitterPosition Method
GetTitleText Method
GetTop Method
GetVisible Method
GetWidth Method
GetWindowState Method
InvokeDialog Method
PrintOutputDoc Method
SetHeight Method
SetLeft Method
SetSplitterPosition Method
SetTop Method
SetVisible Method
SetWidth Method
SetWindowState Method
5. Syntax Documents and Syntax Editor Windows
SpssSyntaxDoc Class
CloseDocument Method
GetDocumentPath Method
GetMenuTable Method
GetSyntax Method
GetSyntaxUI Method
IsDesignatedSyntaxDoc Method
IsEqualTo Method
IsModified Method
IsPromptToSave Method
RunSyntax Method
SaveAs Method
SetAsDesignatedSyntaxDoc Method
SetModified Method
SetPromptToSave Method
SetSyntax Method
SyntaxDocsList Class
GetItemAt Method
Size Method
SpssSyntaxUI Class
GetHeight Method
GetLeft Method
GetTitleText Method
GetTop Method
GetVisible Method
GetWidth Method
GetWindowState Method
InvokeDialog Method
PrintSyntaxDoc Method
SetHeight Method
SetLeft Method
SetTop Method
SetVisible Method
SetWidth Method
SetWindowState Method
6. Output Items
SpssOutputItem Class
ConvertToStdTable Method
ExportToDocument Method
ExportToImage Method
GetAlignment Method
GetDescription Method
GetHeight Method
GetPageBreak Method
GetParentItem Method
GetProcedureName Method
GetSpecificType Method
GetSubType Method
GetTreeLevel Method
GetType Method
GetTypeString Method
GetWidth Method
GetXML Method
IsCurrentItem Method
IsEditable Method
IsEqualTo Method
IsSelected Method
IsVisible Method
SetAlignment Method
SetCurrentItem Method
SetDescription Method
SetHeight Method
SetPageBreak Method
SetProcedureName Method
SetSelected Method
SetSubType Method
SetTreeLevel Method
SetVisible Method
SetWidth Method
SpssChartItem Class
SetXML Method
SPSSSubtype Method
SpssModelItem Class
ExportAllViews Method
SetXML Method
SpssHeaderItem Class
GetChildCount Method
GetChildItem Method
InsertChildItem Method
IsExpanded Method
RemoveChildItem Method
SetExpanded Method
SpssLogItem Class
Append Method
GetTextContents Method
SetTextContents Method
SpssTextItem Class
GetTextContents Method
SetTextContents Method
SpssTitleItem Class
GetTextContents Method
SetTextContents Method
7. Menus
MenuTableList Class
GetItemAt Method
Size Method
SpssMenuItem Class
GetTextContents Method
8. Pivot Tables
Compatibility with previous releases
SpssPivotTable Class
Autofit Method
ClearSelection Method
ColumnLabelArray Method
DataCellArray Method
DisplayTableByRows Method
FootnotesArray Method
GetCaptionText Method
GetFootnoteMarkersPosition Method
GetFootnoteMarkersStyle Method
GetHeight Method
GetRotateColumnLabels Method
GetRotateRowLabels Method
GetTitleText Method
GetUpdateScreen Method
GetVarNamesDisplay Method
GetVarValuesDisplay Method
GetWidowOrphanLines Method
GetWidth Method
Group Method
HideCaption Method
HideFootnote Method
HideTitle Method
InsertFootnote Method
IsDisplayTableByRows Method
LayerLabelArray Method
NavigateToFirstRow Method
NavigateToLastRow Method
NavigateToNextRows Method
NavigateToPreviousRows Method
NumericFormat Method
PivotManager Method
RowLabelArray Method
SelectAllFootnotes Method
SelectCaption Method
SelectCorner Method
SelectTable Method
SelectTableBody Method
SelectTitle Method
SetBackgroundColor Method
SetBottomMargin Method
SetCaptionText Method
SetCornerText Method
SetDataCellWidths Method
SetFootnoteMarkers Method
SetForegroundColor Method
SetHAlign Method
SetHDecDigits Method
SetLeftMargin Method
SetRightMargin Method
SetRotateColumnLabels Method
SetRotateRowLabels Method
SetRowsToDisplayRowCount Method
SetRowsToDisplayTolerance Method
SetTableLook Method
SetTextColor Method
SetTextFont Method
SetTextHidden Method
SetTextSize Method
SetTextStyle Method
SetTextUnderlined Method
SetTitleText Method
SetTopMargin Method
SetUpdateScreen Method
SetVAlign Method
SetVarNamesDisplay Method
SetVarValuesDisplay Method
SetWidowOrphanLines Method
ShowAll Method
ShowAllFootnotes Method
ShowCaption Method
ShowFootnote Method
ShowTitle Method
Ungroup Method
SpssDataCells Class
GetBackgroundColorAt Method
GetBottomMarginAt Method
GetForegroundColorAt Method
GetHAlignAt Method
GetHDecDigitsAt Method
GetLeftMarginAt Method
GetNumColumns Method
GetNumericFormatAt method
GetNumericFormatAtEx method
GetNumRows Method
GetReferredFootnotesAt Method
GetRightMarginAt Method
GetTextColorAt Method
GetTextFontAt Method
GetTextHiddenAt Method
GetTextSizeAt Method
GetTextStyleAt Method
GetTextUnderlinedAt Method
GetTopMarginAt Method
GetVAlignAt Method
GetUnformattedValueAt Method
GetValueAt Method
HideFootnotesAt Method
InsertNewFootnoteAt Method
InsertSharedFootnoteAt Method
ReSizeColumn Method
SelectCellAt Method
SelectReferredFootnotesAt Method
SetBackgroundColorAt Method
SetBottomMarginAt Method
SetForegroundColorAt Method
SetHAlignAt Method
SetHDecDigitsAt Method
SetLeftMarginAt Method
SetNumericFormatAt method
SetNumericFormatAtWithDecimal method
SetRightMarginAt Method
SetTextColorAt Method
SetTextFontAt Method
SetTextHiddenAt Method
SetTextSizeAt Method
SetTextStyleAt Method
SetTextUnderlinedAt Method
SetTopMarginAt Method
SetVAlignAt Method
SetValueAt Method
ShowFootnotesAt Method
SpssDimension Class
GetCategoryValueAt Method
GetCurrentCategory Method
GetDimensionName Method
GetFullDimensionLabel Method
GetNumCategories Method
HideLabel Method
MoveToColumn Method
MoveToLayer Method
MoveToRow Method
SetCurrentCategory Method
SetDimensionName Method
SpssFootnotes Class
ChangeMarkerToRegular Method
ChangeMarkerToSpecial Method
GetBackgroundColorAt Method
GetBottomMarginAt Method
GetCount Method
GetForegroundColorAt Method
GetHAlignAt Method
GetLeftMarginAt Method
GetRightMarginAt Method
GetTextColorAt Method
GetTextFontAt Method
GetTextHiddenAt Method
GetTextSizeAt Method
GetTextStyleAt Method
GetTextUnderlinedAt Method
GetTopMarginAt Method
GetVAlignAt Method
GetValueAt Method
RenumberFootnotes Method
SelectCellAt Method
SetBackgroundColorAt Method
SetBottomMarginAt Method
SetForegroundColorAt Method
SetHAlignAt Method
SetLeftMarginAt Method
SetRightMarginAt Method
SetTextColorAt Method
SetTextFontAt Method
SetTextHiddenAt Method
SetTextSizeAt Method
SetTextStyleAt Method
SetTextUnderlinedAt Method
SetTopMarginAt Method
SetVAlignAt Method
SetValueAt Method
SpssLabels Class
BreakHere Method
GetBackgroundColorAt Method
GetBottomMarginAt Method
GetColumnLabelWidthAt Method
GetForegroundColorAt Method
GetHAlignAt Method
GetLeftMarginAt Method
GetNumColumns Method
GetNumRows Method
GetReferredFootnotesAt Method
GetRightMarginAt Method
GetRowLabelWidthAt Method
GetTextColorAt Method
GetTextFontAt Method
GetTextHiddenAt Method
GetTextSizeAt Method
GetTextStyleAt Method
GetTextUnderlinedAt Method
GetTextWidthAt Method
GetTopMarginAt Method
GetVAlignAt Method
GetValueAt Method
HideAllLabelsInDimensionAt Method
HideFootnotesAt Method
HideLabelsInDimensionAt Method
HideLabelsWithDataAt Method
InsertBefore Method
InsertNewAfter Method
InsertNewBefore Method
InsertNewFootnoteAt Method
InsertSharedFootnoteAt Method
KeepTogether Method
RemoveBreakHere Method
RemoveKeepTogether Method
SelectDataUnderLabelAt Method
SelectLabelAt Method
SelectLabelDataAt Method
SelectReferredFootnotesAt Method
SetBackgroundColorAt Method
SetBottomMarginAt Method
SetColumnLabelWidthAt Method
SetForegroundColorAt Method
SetHAlignAt Method
SetLeftMarginAt Method
SetRightMarginAt Method
SetRowLabelWidthAt Method
SetTextColorAt Method
SetTextFontAt Method
SetTextHiddenAt Method
SetTextSizeAt Method
SetTextStyleAt Method
SetTextUnderlinedAt Method
SetTopMarginAt Method
SetVAlignAt Method
SetValueAt Method
ShowAllLabelsAndDataInDimensionAt Method
ShowAllLabelsInDimensionAt Method
ShowFootnotesAt Method
ShowHiddenDimensionLabelAt Method
Swap Method
SpssLayerLabels Class
GetBackgroundColorAt Method
GetBottomMarginAt Method
GetForegroundColorAt Method
GetHAlignAt Method
GetLeftMarginAt Method
GetNumDimensions Method
GetNumLabelsWide Method
GetRightMarginAt Method
GetTextColorAt Method
GetTextFontAt Method
GetTextHiddenAt Method
GetTextSizeAt Method
GetTextStyleAt Method
GetTextUnderlinedAt Method
GetTopMarginAt Method
GetVAlignAt Method
GetValueAt Method
HideFootnotesAt Method
InsertNewFootnoteAt Method
InsertSharedFootnoteAt Method
SelectLabelAt Method
SelectReferredFootnotesAt Method
SetBackgroundColorAt Method
SetBottomMarginAt Method
SetForegroundColorAt Method
SetHAlignAt Method
SetLeftMarginAt Method
SetRightMarginAt Method
SetTextColorAt Method
SetTextFontAt Method
SetTextHiddenAt Method
SetTextSizeAt Method
SetTextStyleAt Method
SetTextUnderlinedAt Method
SetTopMarginAt Method
SetVAlignAt Method
ShowFootnotesAt Method
SpssPivotMgr Class
GetColumnDimension Method
GetLayerDimension Method
GetNumColumnDimensions Method
GetNumLayerDimensions Method
GetNumRowDimensions Method
GetRowDimension Method
MoveLayersToColumns Method
MoveLayersToRows Method
TransposeRowsWithColumns Method
9. Managing Remote Servers
SpssServerConf Class
Connect Method
ConnectWithSavedPassword Method
Disconnect Method
GetDescription Method
GetServerName Method
GetServerPort Method
GetUserDomain Method
GetUserId Method
GetUseSSL Method
IsDefaultServer Method
IsEqualTo Method
IsLocalServer Method
IsPasswordSaved Method
SetDefaultServer Method
SetDescription Method
SetPassword Method
SetPasswordSaved Method
SetServerName Method
SetServerPort Method
SetUserDomain Method
SetUserId Method
SetUseSSL Method
SpssServerConfList Class
Add Method
Clear Method
Contains Method
GetItemAt Method
Remove Method
RemoveItemAt Method
Size Method
10. Script Context
SpssScriptContext Class
GetOutputDoc Method
GetOutputItem Method
GetOutputItemIndex Method
A. Setting Color Values
B. Export Options
C. String Description of Numeric Formats
D. Preference Options
E. Notices
Index