Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

FieldTypeDescription
eidintegerRead only. Unique integer assigned to each GraphElem.
isEntitybooleanRead only. Returns False (see Entity.)
isJunctorbooleanRead only. Returns False (see Junctor.)
isGroupbooleanRead only. Returns False (see Group.)
isEdgebooleanRead only. Returns False (see Edge.)
canHaveParentbooleanRead only. Returns False (see VertexElem.)
hasParentbooleanRead only. Returns True if has parent.
frametupleRead 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.
annotationstring or NoneThe 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.
isHiddenInCollapsebooleanReturns True if the element is in a collapsed group, otherwise False.
hasAnnotationbooleanReturns True if the element has an annotation, otherwise False.
annotationNumberintegerRead only. The annotation (note) number of the element, an integer, or zero if the element has no note.
displayAnnotationNumberintegerRead 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.
partFramesdictionaryRead 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.
plainAnnotationstring or NoneRead only. the annotation (note) of the element as plain text, or None if the element has no note.
annotationEditorTextEditorReturns 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).
userdictionaryA 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']