draftobjects.label Namespace Reference

Classes
class	Label

Functions
def	make_label (targetpoint=None, target=None, direction=None, distance=None, labeltype=None, placement=None)

Function Documentation

make_label()

def draftobjects.label.make_label	(		targetpoint = None,
			target = None,
			direction = None,
			distance = None,
			labeltype = None,
			placement = None
	)

make_label(targetpoint, target, direction, distance, labeltype, placement)

Function to create a Draft Label annotation object

Parameters
----------
targetpoint : App::Vector
        To be completed

target  : LinkSub
        To be completed

direction : String
        Straight direction of the label
        ["Horizontal","Vertical","Custom"]

distance : Quantity
        Length of the straight segment of label leader line 

labeltype : String
        Label type in
        ["Custom","Name","Label","Position",
        "Length","Area","Volume","Tag","Material"]

placement : Base::Placement
        To be completed

Returns
-------
obj :   App::DocumentObject
        Newly created label object