originpro.worksheet.WBook Class Reference

Inheritance diagram for originpro.worksheet.WBook:

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

Protected Member Functions
	_sheet (self, obj)
Protected Member Functions inherited from originpro.base.DBook
	_get_book_type (self)
	_add_sheet (self, name, active)

Additional Inherited Members
Public Attributes inherited from originpro.base.DBook
	obj
Public Attributes inherited from originpro.base.BaseObject
	obj = obj

Detailed Description

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

Member Function Documentation

_sheet()

originpro.worksheet.WBook._sheet ( self, obj )

protected

Reimplemented from originpro.base.DBook.

add_sheet()

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()

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:

• src/originpro/worksheet.py