xbrl.Fact¶
A Fact class represents a fact element in an XBRL instance document.
-
class
xbrl.Fact(Instance instance, cpp_TIndex nIdx)¶
Attributes¶
-
xbrl.Fact.child_facts¶ Returns a generator object of Fact objects representing all XBRL facts which are direct children of this fact.
-
xbrl.Fact.child_items¶ Returns a generator object of Fact objects representing only XBRL item facts which are direct children of this fact.
-
xbrl.Fact.child_tuples¶ Returns a generator object of Fact objects representing only XBRL tuple facts which are direct children of this fact.
-
xbrl.Fact.concept¶ Returns a Concept object which represents the XBRL concept associated with this XBRL fact.
-
xbrl.Fact.context¶ Returns a Context object which represents the XBRL context associated with this XBRL fact.
-
xbrl.Fact.decimals¶ Returns a string containing the value of the decimals attribute on the fact’s element information item. If no decimals attribute has been defined, then the attribute is None.
-
xbrl.Fact.effective_numeric_value¶ Returns a decimal.Decimal object which represents the XBRL fact’s effective numeric value after rounding with the information provided by the decimals or precision attribute. If the fact’s type definition is not derived from a built-in XBRL numeric type definition, then the attribute returns NaN.
-
xbrl.Fact.element¶ Returns an
xml.Elementobject which represents the XML element information item of the XBRL fact.
-
xbrl.Fact.footnote_elements¶ Returns a generator object of
xml.Elementobjects representing all footnote resources that are associated with this fact.
-
xbrl.Fact.footnotes¶ Returns a generator object of
xbrl.FootnoteResourceobjects for each footnote that has a concept-label relationship (http://www.xbrl.org/2003/arcrole/fact-footnote) to this fact.
-
xbrl.Fact.fraction_value¶ Returns a Fraction object which represents the fraction value denoted by the XBRL fact. If the fact’s type definition is not derived from the built-in XBRL type definition xbrli:fractionItemType, then the attribute returns None.
-
xbrl.Fact.id¶ Returns the id attribute value as a string, or “None” if the XML element doesn’t have an id attribute.
-
xbrl.Fact.nil¶ Returns True if the XBRL fact’s element information item has the xsi:nil attribute set to True.
-
xbrl.Fact.normalized_value¶ Returns the XBRL fact’s schema normalized value as a string.
-
xbrl.Fact.precision¶ Returns a string containing the value of the precision attribute on the fact’s element information item. If no precision attribute has been defined, then the attribute is None.
-
xbrl.Fact.qname¶ Returns an
xml.QNameobject which represents the XML qualified name of the XBRL fact.
-
xbrl.Fact.unit¶ Returns a Unit object which represents the XBRL unit associated with this XBRL fact.
Methods¶
-
xbrl.Fact.complete_scenario_aspect()¶ Returns an
xml.Elementobject which represents the complete scenario aspect of this XBRL fact. If the XBRL fact has no complete scenario aspect, then this attribute is None.
-
xbrl.Fact.complete_segment_aspect()¶ Returns an
xml.Elementobject which represents the complete segment aspect of this XBRL fact. If the XBRL fact has no complete segment aspect, then this attribute is None.
-
xbrl.Fact.concept_aspect()¶ Returns a Concept object which represents the concept aspect of this XBRL fact.
-
xbrl.Fact.entity_identifier_aspect()¶ Returns an EntityIdentifier object which represents the entity identifier aspect of this XBRL fact. If the XBRL fact has no entity identifier aspect, then this attribute is None.
-
xbrl.Fact.explicit_dimension_aspect(qname)¶ Returns an
xml.QNameobject which represents the given qname dimension aspect of this XBRL fact (which is the domain member QName). If the XBRL fact has no such dimension aspect, then this attribute is None. The argument qname must be an object of classxml.QName.
-
xbrl.Fact.is_item()¶ Returns True if the fact is an XBRL item fact.
-
xbrl.Fact.is_tuple()¶ Returns True if the fact is an XBRL tuple fact.
-
xbrl.Fact.location_aspect()¶ Returns an
xml.Elementobject which represents the location aspect of this XBRL fact.
-
xbrl.Fact.non_xdt_scenario_aspect()¶ Returns a list of
xml.Elementobjects which represent the non-XDT scenario aspect of this XBRL fact. If the XBRL fact has no non-XDT scenario aspect, then this attribute is None.
-
xbrl.Fact.non_xdt_segment_aspect()¶ Returns a list of
xml.Elementobjects which represent the non-XDT segment aspect of this XBRL fact. If the XBRL fact has no non-XDT segment aspect, then this attribute is None.
-
xbrl.Fact.period_aspect()¶ Returns a Period object which represents the period aspect of this XBRL fact. If the XBRL fact has no period aspect, then this attribute is None.
-
xbrl.Fact.select_footnotes(footnote_role=None, arc_role=None, link_role=None, lang=None)¶ Returns a generator object of
xbrl.FootnoteResourceobjects for each footnote that has a concept-label relationship (http://www.xbrl.org/2003/arcrole/fact-footnote) to this fact and also matches the given parameters.
-
xbrl.Fact.typed_dimension_aspect(qname)¶ Returns an
xml.Elementobject which represents the given qname dimension aspect of this XBRL fact (which is the typed domain element). If the XBRL fact has no such dimension aspect, then this attribute is None. The argument qname must be an object of classxml.QName.
-
xbrl.Fact.unit_aspect()¶ Returns a Unit object which represents the unit aspect of this XBRL fact. If the XBRL fact has no unit aspect, then this attribute is None.
Special methods¶
__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__