NAME

yEd::Label::EdgeLabel - Textlabels for Edges

DESCRIPTION

Use this class to label your Edges.

Make sure to have a look at yEd::Label, the properties and functions described there will not be repeated here.

If you want to label a Node class element use yEd::Label::NodeLabel.

SUPPORTED FEATURES

see yEd::Label

PROPERTIES

all properties from base class

yEd::Label

positionModell

Type: descrete values ( see below )

Default: 'two_pos-head'

Describes how to position the Label on the Edge.

free

Free positioning (use x, y properties)

two_pos-X

Where X is one of:

  • head : Centered above line

  • tail : Centered below line

centered

Centered on line

six_pos-X

Where X is one of:

  • head : Centered above line

  • shead : At source above line

  • thead : At target above line

  • tail : Centered below line

  • stail : At source below line

  • ttail : At target below line

three_center-X

Where X is one of:

  • center : Centered on line

  • scentr : At source on line

  • tcentr : At target on line

center_slider

On the line position defined by ratio

side_slider

Above or below the line position defined by ratio and y value for above/below (?)

ratio

Type: ration (ufloat [0-1])

Default: 0.5

Defines the Label position for slider positioning modells, where 0 is at source, 1 is at target and 0.5 is centered.

distance

Type: float

Default: 2

Defines the distance of the Label from the Edge (may have no effect depending on positioning modell).

autoFlip

Type: bool

Default: true

Automatically flip the Label if it gets upside-down (because of effective direction of the Edge).

SUBROUTINES/METHODS

all functions from base class

yEd::Label

SEE ALSO

yEd::Document for further informations about the whole package

yEd::PropertyBasedObject for further basic information about properties and their additional functions

yEd::Label for information about the Label base class

yEd::Label::NodeLabel for information about specialized Label elements for Nodes