xbrl.formula.Parameter

An xbrl.formula.Parameter class represents a <variable:parameter> resource in the formula linkbase.

class xbrl.formula.Parameter

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

Attributes

xbrl.formula.Parameter.as_type

Returns an xml.QName object which represents the XML qualified name of the XSD type declaration, or None if the ‘as’ attribute is absent.

xbrl.formula.Parameter.name

Returns an xml.QName object which represents the XML qualified name of the formula parameter.

xbrl.formula.Parameter.required

Returns True if the value of the ‘required’ attribute was set to ‘true’.

xbrl.formula.Parameter.select

Returns an xbrl.XPathExpression object representing the XPath expression in the ‘select’ attribute, or None if the ‘select’ attribute is absent.

Methods

xbrl.formula.Parameter.referenced_parameters()

Returns an iterator of xbrl.formula.Parameter objects representing the referenced formula parameters in the ‘select’ XPath expression.

Special methods

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