arelle.ModelRenderingObject#
See COPYRIGHT.md for copyright information.
Module Contents#
Classes#
Functions#
Data#
API#
- arelle.ModelRenderingObject.ROLLUP_NOT_ANALYZED#
0
- arelle.ModelRenderingObject.CHILD_ROLLUP_FIRST#
1
- arelle.ModelRenderingObject.CHILD_ROLLUP_LAST#
2
- arelle.ModelRenderingObject.CHILDREN_BUT_NO_ROLLUP#
3
- arelle.ModelRenderingObject.OPEN_ASPECT_ENTRY_SURROGATE#
‘\udbff’
- arelle.ModelRenderingObject.EMPTY_SET#
‘set(…)’
- arelle.ModelRenderingObject.definitionNodes(nodes)#
- class arelle.ModelRenderingObject.StructuralNode(parentStructuralNode, breakdownNode, definitionNode, zInheritance=None, contextItemFact=None, tableNode=None, rendrCntx=None)#
Initialization
- property modelXbrl#
- property choiceStructuralNodes#
- property isAbstract#
- isSummary()#
- property isRollUp#
- property cardinalityAndDepth#
- property structuralDepth#
- constraintSet(tagSelectors=None)#
- aspectsCovered(inherit=False)#
- hasAspect(aspect, inherit=True)#
- aspectValue(aspect, inherit=True, dims=None, depth=0, tagSelectors=None)#
- objectId(refId='')#
- header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True)#
- evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)#
- hasValueExpression(otherAxisStructuralNode=None)#
- evalValueExpression(fact, otherAxisStructuralNode=None)#
- property isEntryAspect#
- isEntryPrototype(default=False)#
- property tableDefinitionNode#
- property tagSelectors#
- property leafNodeCount#
- setHasOpenNode()#
- inheritedPrimaryItemQname(view)#
- inheritedExplicitDims(view, dims=None, nested=False)#
- inheritedAspectValue(otherAxisStructuralNode, view, aspect, tagSelectors, xAspectStructuralNodes, yAspectStructuralNodes, zAspectStructuralNodes)#
- __repr__()#
- arelle.ModelRenderingObject.definitionModelLabelsView(mdlObj)#
- class arelle.ModelRenderingObject.ModelEuTable#
Bases:
arelle.ModelDtsObject.ModelResource- init(modelDocument)#
- property aspectModel#
- property propertyView#
- property parameters#
- property definitionLabelsView#
- filteredFacts(xpCtx, facts)#
- property xpathContext#
- __repr__()#
- class arelle.ModelRenderingObject.ModelEuAxisCoord#
Bases:
arelle.ModelDtsObject.ModelResource- init(modelDocument)#
- property abstract#
- property isAbstract#
- property isMerged#
- property parentChildOrder#
- property isRollUp#
- property parentDefinitionNode#
- aspectsCovered()#
- property constraintSets#
- property tagSelector#
- hasAspect(structuralNode, aspect)#
- aspectValueDependsOnVars(aspect)#
- aspectValue(xpCtx, aspect, inherit=False)#
- cardinalityAndDepth(structuralNode, **kwargs)#
- property hasValueExpression#
- property definitionLabelsView#
- property propertyView#
- __repr__()#
- class arelle.ModelRenderingObject.ModelTable#
Bases:
arelle.ModelFormulaObject.ModelFormulaResource- init(modelDocument)#
- clear()#
- property aspectModel#
- property descendantArcroles#
- property filterRelationships#
- property definitionLabelsView#
- filteredFacts(xpCtx, facts)#
- property renderingXPathContext#
- property propertyView#
- __repr__()#
- class arelle.ModelRenderingObject.ModelDefinitionNode#
Bases:
arelle.ModelFormulaObject.ModelFormulaResource- init(modelDocument)#
- property parentDefinitionNode#
- property descendantArcroles#
- hasAspect(structuralNode, aspect)#
- aspectValueDependsOnVars(aspect)#
- property variablename#
(str) – name attribute
- property variableQname#
(QName) – resolved name for an XPath bound result having a QName name attribute
- aspectValue(xpCtx, aspect, inherit=True)#
- aspectsCovered()#
- property constraintSets#
- property tagSelector#
- property valueExpression#
- property hasValueExpression#
- compile()#
- evalValueExpression(xpCtx, fact)#
- property isAbstract#
- property isMerged#
- property isRollUp#
- cardinalityAndDepth(structuralNode, **kwargs)#
- property definitionNodeView#
- property definitionLabelsView#
- class arelle.ModelRenderingObject.ModelBreakdown#
Bases:
arelle.ModelRenderingObject.ModelDefinitionNode- init(modelDocument)#
- property parentChildOrder#
- property descendantArcroles#
- property propertyView#
- class arelle.ModelRenderingObject.ModelClosedDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelDefinitionNode- init(modelDocument)#
- property abstract#
- property isAbstract#
- property parentChildOrder#
- property descendantArcroles#
- filteredFacts(xpCtx, facts)#
- class arelle.ModelRenderingObject.ModelConstraintSet#
Bases:
arelle.ModelFormulaObject.ModelFormulaRules- init(modelDocument)#
- hasAspect(structuralNode, aspect, inherit=None)#
- _hasAspect(structuralNode, aspect, inherit=None)#
- aspectValue(xpCtx, aspect, inherit=None)#
- aspectValueDependsOnVars(aspect)#
- aspectsCovered()#
- property aspectModel#
- cardinalityAndDepth(structuralNode, **kwargs)#
- class arelle.ModelRenderingObject.ModelRuleSet#
Bases:
arelle.ModelRenderingObject.ModelConstraintSet,arelle.ModelFormulaObject.ModelFormulaResource- init(modelDocument)#
- property tagName#
- class arelle.ModelRenderingObject.ModelRuleDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelConstraintSet,arelle.ModelRenderingObject.ModelClosedDefinitionNode- init(modelDocument)#
- property merge#
- property isMerged#
- property constraintSets#
- hasAspect(structuralNode, aspect)#
- property aspectsInTaggedConstraintSet#
- compile()#
- property propertyView#
- __repr__()#
- class arelle.ModelRenderingObject.ModelTupleDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelRuleDefinitionNode- init(modelDocument)#
- property descendantArcroles#
- property contentRelationships#
- hasAspect(structuralNode, aspect, inherit=None)#
- aspectValue(xpCtx, aspect, inherit=None)#
- aspectsCovered()#
- tupleAspectsCovered()#
- filteredFacts(xpCtx, facts)#
- class arelle.ModelRenderingObject.ModelCompositionDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelClosedDefinitionNode- init(modelDocument)#
- property abstract#
- class arelle.ModelRenderingObject.ModelRelationshipDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelClosedDefinitionNode- init(modelDocument)#
- aspectsCovered()#
- property conceptQname#
- property relationshipSourceQname#
- property linkrole#
- property axis#
- property isOrSelfAxis#
- property generations#
- property relationshipSourceQnameExpression#
- property linkroleExpression#
- property axisExpression#
- property generationsExpression#
- compile()#
- variableRefs(progs=[], varRefSet=None)#
- evalRrelationshipSourceQname(xpCtx, fact=None)#
- evalLinkrole(xpCtx, fact=None)#
- evalAxis(xpCtx, fact=None)#
- evalGenerations(xpCtx, fact=None)#
- cardinalityAndDepth(structuralNode, **kwargs)#
- lenDepth(nestedRelationships, includeSelf)#
- property propertyView#
- __repr__()#
- class arelle.ModelRenderingObject.ModelConceptRelationshipDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelRelationshipDefinitionNode- init(modelDocument)#
- hasAspect(structuralNode, aspect)#
- property arcrole#
- property arcQname#
- property linkQname#
- compile()#
- variableRefs(progs=[], varRefSet=None)#
- evalArcrole(xpCtx, fact=None)#
- evalLinkQname(xpCtx, fact=None)#
- evalArcQname(xpCtx, fact=None)#
- property arcroleExpression#
- property linkQnameExpression#
- property arcQnameExpression#
- coveredAspect(ordCntx=None)#
- relationships(structuralNode, **kwargs)#
- class arelle.ModelRenderingObject.ModelDimensionRelationshipDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelRelationshipDefinitionNode- init(modelDocument)#
- hasAspect(structuralNode, aspect)#
- aspectValue(xpCtx, aspect, inherit=None)#
- aspectsCovered()#
- property dimensionQname#
- property dimensionQnameExpression#
- compile()#
- variableRefs(progs=[], varRefSet=None)#
- evalDimensionQname(xpCtx, fact=None)#
- coveredAspect(structuralNode=None)#
- relationships(structuralNode, **kwargs)#
- dimRelationships(structuralNode, getMembers=False, getDimQname=False)#
- stepDimRel(stepConcept, linkrole)#
- arelle.ModelRenderingObject.coveredAspectToken#
None
- class arelle.ModelRenderingObject.ModelOpenDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelDefinitionNode- init(modelDocument)#
- class arelle.ModelRenderingObject.ModelSelectionDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelOpenDefinitionNode- init(modelDocument)#
- property descendantArcroles#
- clear()#
- coveredAspect(structuralNode=None)#
- aspectsCovered()#
- hasAspect(structuralNode, aspect)#
- property select#
- compile()#
- variableRefs(progs=[], varRefSet=None)#
- evaluate(xpCtx, typeQname=None)#
- arelle.ModelRenderingObject.aspectNodeAspectCovered#
None
- class arelle.ModelRenderingObject.ModelFilterDefinitionNode#
Bases:
arelle.ModelRenderingObject.ModelOpenDefinitionNode- init(modelDocument)#
- property descendantArcroles#
- property filterRelationships#
- hasAspect(structuralNode, aspect)#
- aspectsCovered(varBinding=None)#
- aspectValue(xpCtx, aspect, inherit=None)#
- filteredFactsPartitions(xpCtx, facts)#
- property propertyView#