|
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) |
|
base class for all Origin objects
◆ comments() [1/2]
def originpro.base.BaseObject.comments |
( |
|
self | ) |
|
Property getter returns long name of object.
Examples:
wb.comments='My labs data'
print(wb.comments)
◆ comments() [2/2]
def originpro.base.BaseObject.comments |
( |
|
self, |
|
|
|
value |
|
) |
| |
Property setter sets the comments of an object.
Examples:
wb.comments='My labs data'
print(wb.comments)
◆ get_float()
def originpro.base.BaseObject.get_float |
( |
|
self, |
|
|
|
prop |
|
) |
| |
Get object's LabTalk float property
◆ get_int()
def originpro.base.BaseObject.get_int |
( |
|
self, |
|
|
|
prop |
|
) |
| |
Get object's LabTalk int property
◆ get_str()
def originpro.base.BaseObject.get_str |
( |
|
self, |
|
|
|
prop |
|
) |
| |
Get object's LabTalk string property
◆ index()
def originpro.base.BaseObject.index |
( |
|
self | ) |
|
interal index in corresponding collection of the object
◆ lname() [1/2]
def originpro.base.BaseObject.lname |
( |
|
self | ) |
|
Property getter returns long name of object.
Parameters:
Returns:
(str)
Examples:
print(wb.lname)
◆ lname() [2/2]
def originpro.base.BaseObject.lname |
( |
|
self, |
|
|
|
value |
|
) |
| |
Property setter sets long name of object.
Parameters:
value (str): long name
Returns:
None
Examples:
wb.lname = 'My Data'
◆ lt_exec()
def originpro.base.BaseObject.lt_exec |
( |
|
self, |
|
|
|
labtalk |
|
) |
| |
executes a LabTalk statement.
Parameters:
labtalk (str): LabTalk statement
Returns:
None
Examples:
wb.lt_exec('page.longname$="lt_exec example"')
◆ method_float()
def originpro.base.BaseObject.method_float |
( |
|
self, |
|
|
|
name, |
|
|
|
arg = '' |
|
) |
| |
execute object's LabTalk method that has a float return
◆ method_int()
def originpro.base.BaseObject.method_int |
( |
|
self, |
|
|
|
name, |
|
|
|
arg = '' |
|
) |
| |
execute object's LabTalk method that has an int return
◆ method_str()
def originpro.base.BaseObject.method_str |
( |
|
self, |
|
|
|
name, |
|
|
|
arg = '' |
|
) |
| |
execute object's LabTalk method that has a string return
◆ name() [1/2]
def originpro.base.BaseObject.name |
( |
|
self | ) |
|
◆ name() [2/2]
def originpro.base.BaseObject.name |
( |
|
self, |
|
|
|
value |
|
) |
| |
change the short name of an object, if there is a conflict,
Origin will change to next available name automatically
Examples:
gp=op.new_graph()
gp.name='Test'
gp=op.new_graph()
gp.name='Test'
print(gp)#Test1
◆ set_float()
def originpro.base.BaseObject.set_float |
( |
|
self, |
|
|
|
prop, |
|
|
|
value |
|
) |
| |
Set object's LabTalk float property
◆ set_int()
def originpro.base.BaseObject.set_int |
( |
|
self, |
|
|
|
prop, |
|
|
|
value |
|
) |
| |
Set object's LabTalk int property
◆ set_str()
def originpro.base.BaseObject.set_str |
( |
|
self, |
|
|
|
prop, |
|
|
|
value |
|
) |
| |
Set object's LabTalk string property
◆ show() [1/2]
def originpro.base.BaseObject.show |
( |
|
self | ) |
|
Property getter returns show state of object.
Parameters:
Returns:
(bool)
Examples:
print(wb.show)
◆ show() [2/2]
def originpro.base.BaseObject.show |
( |
|
self, |
|
|
|
value |
|
) |
| |
Property setter sets show state of object.
Parameters:
value (bool): True to show object
Returns:
None
Examples:
wb.show = True
◆ userprops()
def originpro.base.BaseObject.userprops |
( |
|
self | ) |
|
Return User Tree as dict
Examples:
wks = op.new_sheet()
wks.set_str('tree.data.name', 'Larry')
wks.set_int('tree.data.age', 37)
wks.set_float('tree.data.mean', 23.56)
dd = wks.userprops['data']
print(dd)
◆ usertree() [1/2]
def originpro.base.BaseObject.usertree |
( |
|
self | ) |
|
Return User Tree as ElementTree
Examples:
wks = op.new_sheet()
wks.set_str('tree.data.name', 'Larry')
wks.set_int('tree.data.age', 37)
wks.set_float('tree.data.mean', 23.56)
trWks = wks.usertree
trData = trWks.find('data')
for child in trData:
print(f'{child.tag} = {child.text}')
◆ usertree() [2/2]
def originpro.base.BaseObject.usertree |
( |
|
self, |
|
|
|
tr |
|
) |
| |
Set User Tree
Parameters:
tr (ElementTree): tree to set
The documentation for this class was generated from the following file: