`xbrl.taxonomy.RoleRef`¶

An xbrl.taxonomy.RoleRef class represents an XBRL roleRef element in the DTS.

Base class: xbrl.taxonomy.SimpleLink

class xbrl.taxonomy.RoleRef¶: Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes¶

xbrl.taxonomy.SimpleLink.document: Returns an xml.Document object which represents the XBRL taxonomy document which contains this XLink simple link.

xbrl.taxonomy.SimpleLink.element: Returns an xml.ElementInformationItem object which represents the XLink simple link element information item.

xbrl.taxonomy.SimpleLink.qname: Returns an xml.QName object which represents the XML qualified name of the XLink simple link element information item.

xbrl.taxonomy.RoleRef.role_type¶: Returns an xbrl.taxonomy.RoleType object which represents the corresponding roleType in the DTS.

xbrl.taxonomy.RoleRef.role_uri¶: Returns the value of the ‘roleURI’ attribute as a string, or None if the XML element information item doesn’t have an ‘roleURI’ attribute.

xbrl.taxonomy.SimpleLink.target_element: Returns an xml.ElementInformationItem object which represents the XML element information item pointed to by the XLink simple link.

xbrl.taxonomy.SimpleLink.xlink_actuate: Returns the value of the ‘xlink:actuate’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:actuate’ attribute.

xbrl.taxonomy.SimpleLink.xlink_arcrole: Returns the value of the ‘xlink:arcrole’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:arcrole’ attribute.

xbrl.taxonomy.SimpleLink.xlink_href: Returns the value of the ‘xlink:href’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:href’ attribute.

xbrl.taxonomy.SimpleLink.xlink_role: Returns the value of the ‘xlink:role’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:role’ attribute.

xbrl.taxonomy.SimpleLink.xlink_show: Returns the value of the ‘xlink:show’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:show’ attribute.

xbrl.taxonomy.SimpleLink.xlink_title: Returns the value of the ‘xlink:title’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:title’ attribute.

Methods¶

xbrl.taxonomy.SimpleLink.xpointer(bForceElementScheme=False): Returns an URI with XPointer fragment that points to this XML element as a string. If the XML element information item has an id attribute, a shorthand pointer with the id attribute value will be generated, otherwise the XPointer element scheme will be used. Set force_element_scheme to True to prevent generation of shorthand pointers.

Special methods¶

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__