`xbrl.taxonomy.ReferenceArc`¶

An xbrl.taxonomy.ReferenceArc class represents an XLink referenceArc element in an XBRL linkbase.

Base class: xbrl.taxonomy.Arc

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

Attributes¶

xbrl.taxonomy.Arc.document: Returns an xml.Document object which represents the XBRL taxonomy document which contains this XLink arc.

xbrl.taxonomy.Arc.element: Returns an xml.ElementInformationItem object which represents the XML element information item of this XLink arc.

xbrl.taxonomy.Arc.extended_link: Returns an xbrl.taxonomy.ExtendedLink object which represents the containin XLink extended link.

xbrl.taxonomy.Arc.order: Returns the inferred ‘order’ value of the arc as decimal.Decimal.

xbrl.taxonomy.Arc.preferred_label: Returns the value of the ‘preferredLabel’ attribute as a string, or None if the XLink arc element information item doesn’t have a ‘preferredLabel’ attribute. If support for XBRL Generic Preferred Label 1.0 is enabled, the @gpl:preferredLabel attribute will also be consulted.

xbrl.taxonomy.Arc.priority: Returns the inferred ‘priority’ value of the arc as int.

xbrl.taxonomy.Arc.qname: Returns an xml.QName object which represents the XML qualified name of the arc element information item.

xbrl.taxonomy.Arc.relationships: Returns an iterator of xbrl.taxonomy.Relationship objects which represents the relationships described by this XLink arc.

xbrl.taxonomy.Arc.titles: Returns an iterator of xml.ElementInformationItem objects which represent the <xl:title> elements present in this XLink arc.

xbrl.taxonomy.Arc.use: Returns the inferred ‘use’ value of the arc as an xbrl.taxonomy.ArcUse enumeration.

xbrl.taxonomy.Arc.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.Arc.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.Arc.xlink_from: Returns the value of the ‘xlink:from’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:from’ attribute.

xbrl.taxonomy.Arc.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.Arc.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.

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

Methods¶

xbrl.taxonomy.Arc.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__