xbrl.Context.Scenario

An xbrl.Context.Scenario class represents a <xbrli:scenario> element with an XBRL context in the XBRL instance.

class xbrl.Context.Scenario

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

Attributes

xbrl.Context.Scenario.child_elements

Returns an iterator of xml.ElementInformationItem objects representing the child elements of the <xbrli:scenario> element information item.

xbrl.Context.Scenario.complete_aspect_value

Returns an xbrl.ScenarioAspectValue object representing the complete scenario aspect value specified in the XBRL context.

xbrl.Context.Scenario.element

Returns an xml.ElementInformationItem object which represents the <xbrli:scenario> element information item.

xbrl.Context.Scenario.explicit_members

Returns an iterator of xbrl.xdt.ExplicitMember objects representing only the <xbrldi:explicitMember> child elements of the <xbrli:scenario> element information item.

xbrl.Context.Scenario.non_xdt_aspect_value

Returns an xbrl.ScenarioAspectValue object representing the non-XDT scenario aspect value specified in the XBRL context.

xbrl.Context.Scenario.non_xdt_child_elements

Returns an iterator of xml.ElementInformationItem objects representing only the non-XDT child elements of the <xbrli:scenario> element information item.

xbrl.Context.Scenario.typed_members

Returns an iterator of xbrl.xdt.TypedMember objects representing only the <xbrldi:typedMember> child elements of the <xbrli:scenario> element information item.

Methods

xbrl.Context.Scenario.explicit_member(Dimension dim)

Returns an xbrl.xdt.ExplicitMember object representing the <xbrldi:explicitMember> child element of the <xbrli:scenario> element information item for the given dimension.

xbrl.Context.Scenario.typed_member(Dimension dim)

Returns an xbrl.xdt.TypedMember object representing the <xbrldi:typedMember> child element of the <xbrli:scenario> element information item for the given dimension.

Special methods

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