Skip to content

Ellipse

Bases: Shape_Type

Represents the XML element Ellipse.

A simple ellipse object. If rotation is required apply a transformation at the Shape level.

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)

Populates this object from a JSON file.

Parameters:

Name Type Description Default
path string

The path to the JSON file

required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name Type Description Default
json_string string

The JSON content as a string

required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name Type Description Default
path string

The path to the XML file

required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name Type Description Default
xml_string string

The XML content as a string

required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name Type Description Default
filename string

The path to the output XML file

required

toXmlString()

Serializes this object to an XML string.

Returns:

Type Description
string

A string containing the XML representation of this object

setX(value)

Sets the value of the X attribute.

The X coordinate of the center of the ellipse. [units pixels]

Parameters:

Name Type Description Default
value float

The value to set

required

getX()

Returns the value of the X attribute.

The X coordinate of the center of the ellipse. [units pixels]

Returns:

Type Description
float

The value of the attribute

setY(value)

Sets the value of the Y attribute.

The Y coordinate of the center of the ellipse. [units pixels]

Parameters:

Name Type Description Default
value float

The value to set

required

getY()

Returns the value of the Y attribute.

The Y coordinate of the center of the ellipse. [units pixels]

Returns:

Type Description
float

The value of the attribute

setRadiusX(value)

Sets the value of the RadiusX attribute.

The horizontal radius of the ellipse. [units pixels]

Parameters:

Name Type Description Default
value float

The value to set

required

getRadiusX()

Returns the value of the RadiusX attribute.

The horizontal radius of the ellipse. [units pixels]

Returns:

Type Description
float

The value of the attribute

setRadiusY(value)

Sets the value of the RadiusY attribute.

The vertical radius of the ellipse. [units pixels]

Parameters:

Name Type Description Default
value float

The value to set

required

getRadiusY()

Returns the value of the RadiusY attribute.

The vertical radius of the ellipse. [units pixels]

Returns:

Type Description
float

The value of the attribute