xbrl.xdt.Dimension

An xbrl.xdt.Dimension class represents an XDT dimension declaration in the DTS.

class xbrl.xdt.Dimension

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

Attributes

xbrl.xdt.Dimension.default_member

Returns an xbrl.taxonomy.Item object representing the default domain member of this dimension, or None if the dimension is not the source of a dimension-default relationship. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.domain_head_network_nodes

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent all heads of the domain network for this dimension. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.effective_members

Returns an iterator of xbrl.taxonomy.Item objects which represent all usable domain members in the domain of this dimension. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.equality_definition

Returns an xbrl.formula.EqualityDefinition object representing the assigned equality definition for this dimension, or None if the dimension’s domain definition is not the source of an equality-definition relationship. Raises an AttributeError if the dimension is not a typed dimension.

xbrl.xdt.Dimension.typed_domain

Returns an xsd.ElementDeclaration object representing the typed domain definition of this dimension. Raises an AttributeError if the dimension is not a typed dimension.

Methods

xbrl.xdt.Dimension.get_domain_head_network_nodes(linkrole)

Returns an iterator of xbrl.xdt.DomainMemberNetworkNode objects which represent the heads of the domain network in the given linkrole. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.get_effective_members(linkrole)

Returns an iterator of xbrl.taxonomy.Item objects which represent the usable domain members in the domain of in this dimension defined in the given linkrole. Raises an AttributeError if the dimension is not an explicit dimension.

xbrl.xdt.Dimension.is_explicit()

Returns True if the XDT dimension declaration corresponds to an explicit dimension (has no ‘xbrldt:typedDomainRef’ attribute).

xbrl.xdt.Dimension.is_typed()

Returns True if the XDT dimension declaration corresponds to a typed dimension (has an ‘xbrldt:typedDomainRef’ attribute).

Special methods

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