30+
years serving the scientific and engineering community
Log In
Buy Now
Try Origin for Free
Watch Videos
English
日本語
Deutsch
Toggle navigation
Products
PRODUCTS
Origin
OriginPro
Origin Viewer
All products
Origin vs. OriginPro
What's new in latest version
Product literature
SHOWCASE
Applications
User Case Studies
Video Tutorials
Graph Gallery
Animation Gallery
3D Function Gallery
FEATURES
2D&3D Graphing
Peak Analysis
Curve Fitting
Statistics
Signal Processing
Key features by version
LICENSING OPTIONS
Node-locked(fixed seat)
Concurrent Network (Floating)
Dongle
Academic users
Student version
Commercial users
Government users
Non-Profit users
Why choose OriginLab
Who's using Origin
What users are saying
Published product reviews
Online Store
Get a quote/Ordering
Find a distributor
Apps
Data Import
CSV Connector
Excel Connector
HTML Connector
HDF Connector
NetCDF Connector
Import NMR Data
Import PDF Tables
Google Map Import
Import Shapefile
More...
Graphing
Graph Maker
Correlation Plot
Paired Comparison Plot
Venn Diagram
Taylor Diagram
Volcano Plot
Kernel Density Plot
Chromaticity Diagram
Heatmap with Dendrogram
More...
Publishing
Graph Publisher
Send Graphs to PowerPoint
Send Graphs to Word
Send Graphs to PDF
Send Graphs to OneNote
Movie Creator
Graph Anim
More...
Curve Fitting
Simple Fit
Speedy Fit
Piecewise Fit
Fit ODE
Fit Convolution
Rank Models
Fitting Function Library
Neural Network Regression
Polynomial Surface fit
Global Fit with Multiple Functions
More...
Peak Analysis
Simple Spectroscopy
Peak Deconvolution
Pulse Integration
Align Peaks
Global Peak Fit
PCA for Spectroscopy
2D Peak Analysis
Gel Molecular Weight Analyzer
More...
Statistics
SPC
DOE
Stats Advisor
PCA
RDA
Bootstrap Sampling
Time Series Analysis
Factor Analysis
General Linear Regression
Logistic Regression
SVM Classification
More...
How do Apps work in Origin?
Suggest a New App
Purchase
New Orders
Renew Maintenance
Upgrade Origin
Contact Sales(US & Canada only)
Find a Distributor
Licensing Options
Node-locked(fixed seat)
Concurrent Network (Floating)
Dongle
Academic users
Student version
Commercial users
Government users
Non-Profit users
Why choose OriginLab
Purchasing FAQ
Support
SERVICES
Transfer Origin to new PC
License/Register Origin
Consulting
Training
Renew Maintenance
SUPPORT
Support FAQ
Help Center
Contact Support
Support Policy
DOWNLOADS
Service Releases
Origin Viewer
Orglab Module
Product Literature
Origin Trial
All downloads
VIDEOS
Installation and Licensing
Introduction to Origin
All video tutorials
DOCUMENTATION
User Guide
Tutorials
Python Programming
OriginC Programming
LabTalk Programming
All documentation
Communities
User Forum
User File Exchange
About Us
OriginLab Corp.
News & Events
Careers
Distributors
Contact Us
Contact Us
Log In
All Books
Non-Programming Books
User Guide
Tutorials
Quick Help
Origin Help
Programming Books
X-Function
Origin C
LabTalk Programming
Python
Python (External)
Automation Server
LabVIEW VI
Apps
App Development
Code Builder
License
Orglab
8.2 PyOrigin Global Functions
It is recommended that you switch to the
originpro
package. PyOrigin is primarily for users who need to work with Origin version prior to 2021.
Global-Functions
Name
Brief
Example
ActiveFolder
Gets the active Folder in the project
Examples
ActiveLayer
Get the active Layer object in the project
Examples
ActiveNotePage
Get the active Notes in the project
Examples
ActivePage
Get the active Page in the project
Examples
AddTree
Adds a Tree Object to a serializable Internal Tree Manager
Examples
CreatePage
Create new page (workbook, graph, matrix book, Notes .etc) in the project
Examples
Date2datetime
Convert a double in Julian date format to a system time struct
Examples
datetime2Date
Convert a SYSTEMTIME structure to a Julian date value.
Examples
DestroyPage
Destory the specified page
Examples
EmptyTree
Create an empty tree in Origin
Examples
FindGraphLayer
Get the GraphLayer by name
Examples
FindMatrixSheet
Get the MatrixSheet by name
Examples
FindWorksheet
Get the Worksheet by name
Examples
GetName
Get the Origin project name
Examples
GetPage
Get the page by name
Examples
GetPath
Get the path of the Origin file
Examples
GetProjectInfo
Get the object ProjectInfo
Examples
GetRootFolder
Get the root folder of the project
Examples
GetTree
Get the Tree if available
Examples
GraphPages
Get the GraphPage
Examples
IsModified
Get the GraphLayer by name
Examples
LayoutPages
Get the LayoutPages by name
Examples
LT_execute
Execute the Labtalk script
Examples
LT_set_str
Set LabTalk string variable
Examples
LT_set_var
Set LabTalk variable
Examples
LT_get_var
Get LabTalk variable
Examples
LT_get_str
Get LabTalk string variable
Examples
Load
Load the file into Origin by read only or read/write
Examples
MatrixPages
Get the MatrixPages
Examples
MISSINGVALUE
Get a missing value
Examples
NewDataRange
Create a DataRange object
Examples
OriginVer
Get Origin version
Examples
Pages
Get the Pages
Examples
Reset
Reset the contents in Workbook or Matrix book
Examples
Run
Allow Origin to finish current operations. This is useful after calling a method that triggers lengthy auto-update calculations
Examples
Save
Save the current Origin session to an Origin project (OPJ) file.
Examples
XF
Execute X function
Examples
SetModified
SetModified property sets or clears modified flag for currently open Origin project without saving it.
Examples
SetAsChildren
Set the treenode as Children
WorksheetPages
Get the WorksheetPages
Examples
Skip Navigation Links
All Books
Python
PyOrigin in Embedded Python
PyOrigin Global Functions
User Guide
Tutorials
Quick Help
Origin Help
X-Function
Origin C
LabTalk Programming
Python
Python (External)
Automation Server
LabVIEW VI
Apps
App Development
Code Builder
License
Orglab
Programming
Embedded Python
Installing and Managing Python Packages
Running Python Code
Using Python in Tools and Dialogs
Python Code Samples
Sample Projects with attached Python Code
Documentation for originpro package
PyOrigin in Embedded Python
PyOrigin Classes
PyOrigin Global Functions
ActiveFolder
ActiveLayer
ActiveNotePage
ActivePage
AddTree
CreatePage
Date2datetime
datetime2Date
DestroyPage
EmptyTree
FindGraphLayer
FindMatrixSheet
FindWorksheet
GetName
GetPage
GetPath
GetProjectInfo
GetRootFolder
GetTree
GraphPages
IsModified
LayoutPages
Load
LT_execute
LT_get_str
LT_get_var
LT_set_str
LT_set_var
MatrixPages
MISSINGVALUE
NewDataRange
OriginVer
Pages
Reset
Run
Save
SetAsChildren
SetModified
WorksheetPages
XF
English
|
Deutsch
|
日本語
© OriginLab Corporation. All rights reserved.
×
☐
_
Let's Chat