xbrl.taxonomy.Linkbase¶
An xbrl.taxonomy.Linkbase class represents an XBRL linkbase.
-
class
xbrl.taxonomy.Linkbase¶ Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a
NotImplementedErrorexception.
Attributes¶
-
xbrl.taxonomy.Linkbase.arcrole_refs¶ Returns an iterator of
xbrl.taxonomy.ArcroleRefobjects which represent the XBRL arcroleRefs present in this linkbase.
-
xbrl.taxonomy.Linkbase.document¶ Returns an
xml.Documentobject which represents the XBRL taxonomy document which contains this XBRL linkbase.
-
xbrl.taxonomy.Linkbase.documentation¶ Returns an iterator of
xml.ElementInformationItemobjects which represent the <link:documentation> elements present in this linkbase.
-
xbrl.taxonomy.Linkbase.element¶ Returns an
xml.ElementInformationItemobject which represents the XML element information item of the XBRL linkbase.
-
xbrl.taxonomy.Linkbase.extended_links¶ Returns an iterator of
xbrl.taxonomy.ExtendedLinkobjects which represent the XLink extended links present in this linkbase.
-
xbrl.taxonomy.Linkbase.id¶ Returns the value of the ‘id’ attribute as a string, or None if the XML element information item doesn’t have an ‘id’ attribute.
-
xbrl.taxonomy.Linkbase.qname¶ Returns an
xml.QNameobject which represents the XML qualified name of the linkbase element information item.
-
xbrl.taxonomy.Linkbase.role_refs¶ Returns an iterator of
xbrl.taxonomy.RoleRefobjects which represent the XBRL roleRefs present in this linkbase.
Methods¶
-
xbrl.taxonomy.Linkbase.arcrole_ref(arcroleURI)¶ Returns an
xbrl.taxonomy.ArcroleRefobject which represents the XBRL arcroleRef with the given arcroleURI, or None if no XBRL arcroleRef was found.
-
xbrl.taxonomy.Linkbase.role_ref(roleURI)¶ Returns an
xbrl.taxonomy.RoleRefobject which represents the XBRL roleRef with the given roleURI, or None if no XBRL roleRef was found.
-
xbrl.taxonomy.Linkbase.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__