GraphElem

The GraphElem is the base class for all representations of graph elements: entities, junctors, groups and edges. This class has variables and methods common to all elements.

Fields

Field

Type

Description

eid

integer

Read only. Unique integer assigned to each GraphElem.

isEntity

boolean

Read only. Returns False (see Entity.)

isJunctor

boolean

Read only. Returns False (see Junctor.)

isGroup

boolean

Read only. Returns False (see Group.)

isEdge

boolean

Read only. Returns False (see Edge.)

canHaveParent

boolean

Read only. Returns False (see VertexElem.)

hasParent

boolean

Read only. Returns True if has parent.

frame

tuple

Read only. The element’s bounds as a tuple (left, top, width, height), or (0, 0, 0, 0) if the element is hidden in a collapsed group.

annotation

string or None

The annotation (note) of the element, an HTML document as a string, or None if the element has no note. If set to plain text, the font of the annotation defaults to Monospaced/12.

isHiddenInCollapse

boolean

Returns True if the element is in a collapsed group, otherwise False.

hasAnnotation

boolean

Returns True if the element has an annotation, otherwise False.

annotationNumber

integer

Read only. The annotation (note) number of the element, an integer, or zero if the element has no note.

displayAnnotationNumber

integer

Read only. The annotation (note) number of the element if note numbers are displayed as an integer, or zero if the element has no note or note numbers are not displayed.

partFrames

dictionary

Read only. A dictionary of tuples (x, y, width, height). The keys are Shape Part Types for visual elements that vary by GraphElem type and state.

plainAnnotation

string or None

Read only. the annotation (note) of the element as plain text, or None if the element has no note.

annotationEditor

Returns a TextEditor instance which allows for modification of the annotation, or None if the element has no note (variable is read only, the TextEditor itself can be modified).

user

dictionary

A dictionary containing user defined attributes (variable is read only, the dictionary itself can be modified) Example: previousFacility = elem.user['facility']; elem.user['facility'] = 'Los Angeles'; del elem.user['careless']

Last updated