Label¶

Bases: Shape_Type

Represents the XML element Label.

The text label. Any transformation should be applied at the shape level.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Label.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Label`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setX(value, validate=True)` ¶

Sets the value of the X attribute.

This defines the X coordinate of the current text position of the first character in the string. [units pixels]

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getX()` ¶

Returns the value of the X attribute.

This defines the X coordinate of the current text position of the first character in the string. [units pixels]

Returns:

Type	Description
`float`	The value of the attribute

`resetX()` ¶

`hasX()` ¶

Checks whether the X attribute is present.

This defines the X coordinate of the current text position of the first character in the string. [units pixels]

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setY(value, validate=True)` ¶

Sets the value of the Y attribute.

This defines the Y coordinate of the current text position of the first character in the string. [units pixels]

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getY()` ¶

Returns the value of the Y attribute.

This defines the Y coordinate of the current text position of the first character in the string. [units pixels]

Returns:

Type	Description
`float`	The value of the attribute

`resetY()` ¶

`hasY()` ¶

Checks whether the Y attribute is present.

This defines the Y coordinate of the current text position of the first character in the string. [units pixels]

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

Label¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setX(value, validate=True) ¶

getX() ¶

resetX() ¶

hasX() ¶

setY(value, validate=True) ¶

getY() ¶

resetY() ¶

hasY() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setX(value, validate=True)` ¶

`getX()` ¶

`resetX()` ¶

`hasX()` ¶

`setY(value, validate=True)` ¶

`getY()` ¶

`resetY()` ¶

`hasY()` ¶