originpro.base.BaseLayer Class Reference

Inheritance diagram for originpro.base.BaseLayer:

Public Member Functions
def	__str__ (self)
def	activate (self)
def	destroy (self)
def	label (self, name)
def	remove_label (self, label)
def	add_label (self, text, x=None, y=None)
def	add_line (self, x1, y1, x2, y2)
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

base class for all Origin layers

Member Function Documentation

__str__()

def originpro.base.BaseLayer.__str__

(

self

)

Reimplemented from originpro.base.BaseObject.

activate()

def originpro.base.BaseLayer.activate

(

self

)

make layer/sheet active
Parameters:
    none
Returns:
    last_active layer index
Examples:
    wks = op.find_sheet()
    wb = wks.get_book()
    wb.add_sheet()
    wks.activate()

add_label()

def originpro.base.BaseLayer.add_label	(		self,
			text,
			x = None,
			y = None
	)

Add a label to a layer.

Parameters:
    text (str): The text of a text label
    x(float or None): The X coordinate of the left of the object
    y(float or None): The Y coordinate of the top of the object

Returns:
    (Label)

Examples:
    gp = op.new_graph()
    gl = gp[0]
    text = gl.add_label("hello", 4, 8)
    text.text = 'world'

add_line()

def originpro.base.BaseLayer.add_line	(		self,
			x1,
			y1,
			x2,
			y2
	)

Add a line to a layer.

Parameters:
    x1(float or None): The begin X coordinate
    y1(float or None): The brgin Y coordinate
    x2(float or None): The end X coordinate
    y2(float or None): The end Y coordinate

Returns:
    (Line)

Examples:
    gp = op.new_graph()
    gl = gp[0]
    line = gl.add_line(5, 5, 6, 8)
    line.width = 5
    line.set_int('arrowendshape', 2)

destroy()

def originpro.base.BaseLayer.destroy

(

self

)

delete the sheet/layer
Parameters:
    none
Returns:
    none
Examples:
    wks1=op.new_sheet()
    wks1.destroy()

label()

def originpro.base.BaseLayer.label	(		self,
			name
	)

Get a Label instance by name.

Parameters:
    name (str): name of the label to be attached
Returns:
    (Label)

Examples:
    g = op.new_graph()
    g[0].label('XB').remove()

remove_label()

def originpro.base.BaseLayer.remove_label	(		self,
			label
	)

Remove a label from a layer.

Parameters:
    label (Label or str): Instance of Label or name of label to remove

Returns:
    None

Examples:
    g = op.new_graph()
    g[0].remove_label('xb') # g[0] is 1st layer.

---

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

• src/originpro/base.py