Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfGMLSupport :: Module GmlLabelPlacement' :: Class GmlLabelPlacement
[hide private]
[frames] | no frames]

Class GmlLabelPlacement

                         object --+        
                                  |        
                   Element'.Element --+    
                                      |    
Core.IdentifiedObject'.IdentifiedObject --+
                                          |
                                         GmlLabelPlacement

Used to position a label relative to a point or a line.Used to position a label relative to a point or a line.

Instance Methods [hide private]
 
__init__(self, displacementX='', rotation='', displacementY='', type='', anchorX='', anchorY='', offset='', GmlTextSymbols=None, *args, **kw_args)
Initialises a new 'GmlLabelPlacement' instance.
 
addGmlTextSymbols(self, *GmlTextSymbols)
 
getGmlTextSymbols(self)
 
removeGmlTextSymbols(self, *GmlTextSymbols)
 
setGmlTextSymbols(self, value)

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'anchorX': <type 'str'>, 'anchorY': <type 'str'...
  _attrs = ['displacementX', 'rotation', 'displacementY', 'type'...
  _defaults = {'anchorX': '', 'anchorY': '', 'displacementX': ''...
  _many_refs = ['GmlTextSymbols']
  _refs = ['GmlTextSymbols']

Inherited from Element'.Element (private): _enums

Properties [hide private]
  GmlTextSymbols

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, displacementX='', rotation='', displacementY='', type='', anchorX='', anchorY='', offset='', GmlTextSymbols=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'GmlLabelPlacement' instance.

Parameters:
  • displacementX - X displacement from the main-geometry point to render a text label.
  • rotation - Clockwise rotation of the label in degrees from the normal direction for a font.
  • displacementY - Y displacement from the main-geometry point to render a text label.
  • type - Type of 'LabelPlacement' which in turn specifies where and how a text label should be rendered relative to a geometry.
  • anchorX - X-coordinate location inside of a label to use for anchoring the label to the main-geometry point.
  • anchorY - Y-coordinate location inside of a label to use for anchoring the label to the main-geometry point.
  • offset - Perpendicular distance away from a line to draw a label. The distance is in pixels and is positive to the left-hand side of the line string. Negative numbers mean right. The default offset is 0.
  • GmlTextSymbols
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'anchorX': <type 'str'>,
 'anchorY': <type 'str'>,
 'displacementX': <type 'str'>,
 'displacementY': <type 'str'>,
 'offset': <type 'str'>,
 'rotation': <type 'str'>,
 'type': <type 'str'>}

_attrs

Value:
['displacementX',
 'rotation',
 'displacementY',
 'type',
 'anchorX',
 'anchorY',
 'offset']

_defaults

Value:
{'anchorX': '',
 'anchorY': '',
 'displacementX': '',
 'displacementY': '',
 'offset': '',
 'rotation': '',
 'type': ''}

Property Details [hide private]

GmlTextSymbols

Get Method:
getGmlTextSymbols(self)
Set Method:
setGmlTextSymbols(self, value)