OriginPro
Public Member Functions | List of all members
originpro.worksheet.WBook Class Reference
Inheritance diagram for originpro.worksheet.WBook:
originpro.base.DBook originpro.base.BasePage originpro.base.BaseObject

Public Member Functions

def add_sheet (self, name='', active=True)
 
def unembed_sheet (self, sheet)
 
- Public Member Functions inherited from originpro.base.DBook
def __repr__ (self)
 
def __getitem__ (self, index)
 
def __iter__ (self)
 
- Public Member Functions inherited from originpro.base.BasePage
def __len__ (self)
 
def is_open (self)
 
def is_active (self)
 
def lt_range (self)
 
def activate (self)
 
def destroy (self)
 
def duplicate (self)
 
- Public Member Functions inherited from originpro.base.BaseObject
def __init__ (self, obj)
 
def __del__ (self)
 
def __str__ (self)
 
def __bool__ (self)
 
def index (self)
 
def get_str (self, prop)
 
def get_int (self, prop)
 
def get_float (self, prop)
 
def set_str (self, prop, value)
 
def set_int (self, prop, value)
 
def set_float (self, prop, value)
 
def method_int (self, name, arg='')
 
def method_float (self, name, arg='')
 
def method_str (self, name, arg='')
 
def lt_exec (self, labtalk)
 
def name (self)
 
def name (self, value)
 
def lname (self)
 
def lname (self, value)
 
def comments (self)
 
def comments (self, value)
 
def show (self)
 
def show (self, value)
 
def usertree (self)
 
def usertree (self, tr)
 
def userprops (self)
 

Additional Inherited Members

- Public Attributes inherited from originpro.base.BaseObject
 obj
 

Detailed Description

This class represents an Origin Workbook, it holds an instance of a PyOrigin WorksheetPage.

Member Function Documentation

◆ add_sheet()

def originpro.worksheet.WBook.add_sheet (   self,
  name = '',
  active = True 
)
add a new worksheet to the workbook

Parameters:
    name (str): the name of the new sheet. If not specified, default names will be used
    active (bool): Activate the newly added sheet or not

◆ unembed_sheet()

def originpro.worksheet.WBook.unembed_sheet (   self,
  sheet 
)
unembeds and activates embedded graph sheet
if graph was embedded in worksheet by Add Graph as Sheet, this
unembeds the page and deletes the worksheet.

Parameters:
    sheet (int or str): sheet index, or sheet name
Returns:
    (None)

Example:
    book = op.find_book('w','Book1')
    book.unembed_sheet(1)
    #book.unembed_sheet('Graph1') #can also use using sheet name

The documentation for this class was generated from the following file: