Inheritance diagram for originpro.base.BaseLayer:

Public Member Functions
	__str__ (self)

	activate (self)

	destroy (self)

	label (self, name)

	remove_label (self, label)

	add_label (self, text, x=None, y=None)

	add_line (self, x1, y1, x2, y2)

Public Member Functions inherited from originpro.base.BaseObject
	__init__ (self, obj)

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

Public Attributes
	obj

Public Attributes inherited from originpro.base.BaseObject
	obj = obj

Detailed Description

base class for all Origin layers

Member Function Documentation

◆ str()

originpro.base.BaseLayer.__str__ ( self )

Reimplemented from originpro.base.BaseObject.

◆ activate()

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

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

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

originpro.base.BaseLayer.destroy ( self )

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

◆ label()

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

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

Public Member Functions

Public Attributes