arelle.ModelRenderingObject

See COPYRIGHT.md for copyright information.

Module Contents

Classes

LytMdlTableModel
LytMdlTableSet
LytMdlTable
LytMdlHeaders
LytMdlGroup
LytMdlHeader
LytMdlCell
LytMdlConstraint
LytMdlBodyCells
LytMdlBodyCell
StrctMdlNode
StrctMdlTableSet
StrctMdlTable
StrctMdlBreakdown
StrctMdlStructuralNode
DefnMdlTable
DefnMdlBreakdown
DefnMdlDefinitionNode
DefnMdlClosedDefinitionNode
DefnMdlConstraintSet
DefnMdlRuleSet
DefnMdlRuleDefinitionNode
DefnMdlRelationshipNode
DefnMdlConceptRelationshipNode
DefnMdlDimensionRelationshipNode
DefnMdlOpenDefinitionNode
DefnMdlAspectNode

Functions

definitionNodes
parentChildOrder
aspectStrctNodes
defnMdlLabelsView

Data

NoneType
OPEN_ASPECT_ENTRY_SURROGATE
UNREPORTED_ASPECT_SORT_VALUE
EMPTY_SET
EMPTY_DICT
ROLLUP_SPECIFIES_MEMBER
ROLLUP_IMPLIES_DEFAULT_MEMBER
ROLLUP_FOR_CONCEPT_RELATIONSHIP_NODE
ROLLUP_FOR_DIMENSION_RELATIONSHIP_NODE
ROLLUP_FOR_CLOSED_DEFINITION_NODE
ROLLUP_FOR_OPEN_DEFINITION_NODE
ROLLUP_FOR_DEFINITION_NODE
TABLE_PERIOD_SELECTORS
coveredAspectToken
aspectNodeAspectCovered

API

arelle.ModelRenderingObject.NoneType

‘type(…)’

arelle.ModelRenderingObject.OPEN_ASPECT_ENTRY_SURROGATE

‘\udbff’

arelle.ModelRenderingObject.UNREPORTED_ASPECT_SORT_VALUE

‘\udbfe’

arelle.ModelRenderingObject.EMPTY_SET

‘set(…)’

arelle.ModelRenderingObject.EMPTY_DICT

None

arelle.ModelRenderingObject.ROLLUP_SPECIFIES_MEMBER

1

arelle.ModelRenderingObject.ROLLUP_IMPLIES_DEFAULT_MEMBER

2

arelle.ModelRenderingObject.ROLLUP_FOR_CONCEPT_RELATIONSHIP_NODE

3

arelle.ModelRenderingObject.ROLLUP_FOR_DIMENSION_RELATIONSHIP_NODE

4

arelle.ModelRenderingObject.ROLLUP_FOR_CLOSED_DEFINITION_NODE

5

arelle.ModelRenderingObject.ROLLUP_FOR_OPEN_DEFINITION_NODE

6

arelle.ModelRenderingObject.ROLLUP_FOR_DEFINITION_NODE

7

arelle.ModelRenderingObject.TABLE_PERIOD_SELECTORS

None

exception arelle.ModelRenderingObject.ResolutionException(code, message, **kwargs)

Bases: Exception

add_note()

class args

with_traceback()

class arelle.ModelRenderingObject.LytMdlTableModel(entryPointUrl)

Initialization

class arelle.ModelRenderingObject.LytMdlTableSet(lytMdlTableModel, strctMdlTableSet, label, srcFile, srcLine, srcLinkrole)

Initialization

class arelle.ModelRenderingObject.LytMdlTable(lytMdlTableSet, strctMdlTable)

Initialization

lytMdlAxisHeaders(axis)

headerDepth(axis, includeOpenAspectEntrySurrogates=False)

numBodyCells(axis)

class arelle.ModelRenderingObject.LytMdlHeaders(lytMdlTable, axis)

Initialization

class arelle.ModelRenderingObject.LytMdlGroup(lytMdlHeaders, label, srcFile, srcLine)

Initialization

class arelle.ModelRenderingObject.LytMdlHeader(lytMdlGroup)

Initialization

property maxNumLabels

class arelle.ModelRenderingObject.LytMdlCell

Initialization

labelXmlText(iLabel, default='')

class arelle.ModelRenderingObject.LytMdlConstraint(lytMdlCell, tag)

Initialization

class arelle.ModelRenderingObject.LytMdlBodyCells(lytMdlParent, axis)

Initialization

class arelle.ModelRenderingObject.LytMdlBodyCell(lytMdlParent, isOpenAspectEntrySurrogate=False)

Initialization

arelle.ModelRenderingObject.definitionNodes(nodes)

arelle.ModelRenderingObject.parentChildOrder(node)

arelle.ModelRenderingObject.aspectStrctNodes(strctNode)

class arelle.ModelRenderingObject.StrctMdlNode(strctMdlParentNode, defnMdlNode=None)

Initialization

property axis

property depth

aspectsCovered(inherit=False)

hasAspect(aspect, inherit=True)

property parentChildOrder

property hasRollUpChild

property tagSelectors

property leafNodeCount

property cardinalityAndDepth

objectId(refId='')

property xlinkLabel

property structuralDepth

property childRollupStrctNode

headerAndSource(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

property isAbstract

property isEntryAspect

isEntryPrototype(default=False)

evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)

hasValueExpression(otherAxisStructuralNode=None)

evalValueExpression(fact, otherAxisStructuralNode=None)

property hasBreakdownWithoutNodes

class arelle.ModelRenderingObject.StrctMdlTableSet(defnMdlTable)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

property axis

property depth

aspectsCovered(inherit=False)

hasAspect(aspect, inherit=True)

property parentChildOrder

property hasRollUpChild

property tagSelectors

property leafNodeCount

property cardinalityAndDepth

objectId(refId='')

property xlinkLabel

property structuralDepth

property childRollupStrctNode

headerAndSource(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

property isAbstract

property isEntryAspect

isEntryPrototype(default=False)

evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)

hasValueExpression(otherAxisStructuralNode=None)

evalValueExpression(fact, otherAxisStructuralNode=None)

property hasBreakdownWithoutNodes

class arelle.ModelRenderingObject.StrctMdlTable(strctMdlParentNode, defnMdlTable)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

strctMdlFirstAxisBreakdown(axis)

property axis

property depth

aspectsCovered(inherit=False)

hasAspect(aspect, inherit=True)

property parentChildOrder

property hasRollUpChild

property tagSelectors

property leafNodeCount

property cardinalityAndDepth

objectId(refId='')

property xlinkLabel

property structuralDepth

property childRollupStrctNode

headerAndSource(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

property isAbstract

property isEntryAspect

isEntryPrototype(default=False)

evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)

hasValueExpression(otherAxisStructuralNode=None)

evalValueExpression(fact, otherAxisStructuralNode=None)

property hasBreakdownWithoutNodes

class arelle.ModelRenderingObject.StrctMdlBreakdown(strctMdlParentNode, defnMdlBreakdown, axis)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

siblingBreakdownNode()

property strctMdlAncestorBreakdownNode

property strctMdlEffectiveChildNodes

setHasOpenNode()

inheritedAspectValue(*args)

property axis

property depth

aspectsCovered(inherit=False)

hasAspect(aspect, inherit=True)

property parentChildOrder

property hasRollUpChild

property tagSelectors

property leafNodeCount

property cardinalityAndDepth

objectId(refId='')

property xlinkLabel

property structuralDepth

property childRollupStrctNode

headerAndSource(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

property isAbstract

property isEntryAspect

isEntryPrototype(default=False)

evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)

hasValueExpression(otherAxisStructuralNode=None)

evalValueExpression(fact, otherAxisStructuralNode=None)

property hasBreakdownWithoutNodes

class arelle.ModelRenderingObject.StrctMdlStructuralNode(strctMdlParentNode, defnMdlNode, zInheritance=None, contextItemFact=None, tableNode=None, rendrCntx=None)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

property modelXbrl

property structuralDepth

siblingBreakdownNode()

property strctMdlEffectiveChildNodes

property strctMdlAncestorBreakdownNode

constraintSet(tagSelectors=None)

constraintTags()

aspectsCovered(inherit=False)

hasAspect(aspect, inherit=True)

dimRAV(aspect, value)

aspectValue(aspect, inherit=True, dims=None, depth=0, tagSelectors=None)

property tableDefinitionNode

property leafNodeCount

setHasOpenNode()

inheritedPrimaryItemQname(view)

inheritedExplicitDims(view, dims=None, nested=False)

inheritedAspectValue(otherAxisStructuralNode, view, aspect, tagSelectors, xAspectStructuralNodes, yAspectStructuralNodes, zAspectStructuralNodes)

property axis

property depth

property parentChildOrder

property hasRollUpChild

property tagSelectors

property cardinalityAndDepth

objectId(refId='')

property xlinkLabel

property childRollupStrctNode

headerAndSource(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

header(role=None, lang=None, evaluate=True, returnGenLabel=True, returnMsgFormatString=False, recurseParent=True, returnStdLabel=True, layoutMdlSortOrder=False)

property isAbstract

property isEntryAspect

isEntryPrototype(default=False)

evaluate(evalObject, evalMethod, otherAxisStructuralNode=None, evalArgs=(), handleXPathException=True, **kwargs)

hasValueExpression(otherAxisStructuralNode=None)

evalValueExpression(fact, otherAxisStructuralNode=None)

property hasBreakdownWithoutNodes

arelle.ModelRenderingObject.defnMdlLabelsView(mdlObj)

class arelle.ModelRenderingObject.DefnMdlTable

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

property isMerged

property parentTableNode

property parentChildOrder

property descendantArcroles

property ancestorArcroles

property aspectModel

property filterRelationships

property definitionLabelsView

filteredFacts(xpCtx, facts)

property renderingXPathContext

property propertyView

property definitionNodeView

class arelle.ModelRenderingObject.DefnMdlBreakdown

Bases: arelle.ModelFormulaObject.ModelFormulaResource

strctMdlRollupType

None

init(modelDocument)

property isMerged

hasAspect(*args)

property parentTableNode

property parentChildOrder

property descendantArcroles

property ancestorArcroles

property childrenCoverSameAspects

aspectsCovered()

property constraintSets

property isAbstract

cardinalityAndDepth(structuralNode, **kwargs)

property propertyView

property definitionNodeView

property definitionLabelsView

class arelle.ModelRenderingObject.DefnMdlDefinitionNode

Bases: arelle.ModelFormulaObject.ModelFormulaResource

aspectModel

‘dimensional’

init(modelDocument)

property isMerged

property parentTableNode

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

cardinalityAndDepth(structuralNode, **kwargs)

property definitionNodeView

property definitionLabelsView

property parentChildOrder

class arelle.ModelRenderingObject.DefnMdlClosedDefinitionNode

Bases: arelle.ModelRenderingObject.DefnMdlDefinitionNode

strctMdlRollupType

None

init(modelDocument)

property abstract

property isAbstract

property parentChildOrder

property descendantArcroles

property ancestorArcroles

filteredFacts(xpCtx, facts)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

hasAspect(structuralNode, aspect)

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

aspectValue(xpCtx, aspect, inherit=True)

aspectsCovered()

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

compile()

evalValueExpression(xpCtx, fact)

cardinalityAndDepth(structuralNode, **kwargs)

property definitionNodeView

property definitionLabelsView

class arelle.ModelRenderingObject.DefnMdlConstraintSet

Bases: arelle.ModelFormulaObject.ModelFormulaRules

init(modelDocument)

isMerged()

hasAspect(structuralNode, aspect, inherit=None)

aspectValue(xpCtx, aspect, inherit=None)

aspectValueDependsOnVars(aspect)

aspectsCovered()

aspectsModelCovered()

cardinalityAndDepth(structuralNode, **kwargs)

class arelle.ModelRenderingObject.DefnMdlRuleSet

Bases: arelle.ModelRenderingObject.DefnMdlConstraintSet, arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

property tagName

isMerged()

hasAspect(structuralNode, aspect, inherit=None)

aspectValue(xpCtx, aspect, inherit=None)

aspectValueDependsOnVars(aspect)

aspectsCovered()

aspectsModelCovered()

cardinalityAndDepth(structuralNode, **kwargs)

class arelle.ModelRenderingObject.DefnMdlRuleDefinitionNode

Bases: arelle.ModelRenderingObject.DefnMdlConstraintSet, arelle.ModelRenderingObject.DefnMdlClosedDefinitionNode

init(modelDocument)

property merge

property isMerged

property constraintSets

hasAspect(structuralNode, aspect)

property aspectsInTaggedConstraintSet

compile()

property propertyView

aspectValue(xpCtx, aspect, inherit=None)

aspectValueDependsOnVars(aspect)

aspectsCovered()

aspectsModelCovered()

cardinalityAndDepth(structuralNode, **kwargs)

strctMdlRollupType

None

property abstract

property isAbstract

property parentChildOrder

property descendantArcroles

property ancestorArcroles

filteredFacts(xpCtx, facts)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property parentTableNode

property variablename

property variableQname

property tagSelector

property valueExpression

property hasValueExpression

evalValueExpression(xpCtx, fact)

property definitionNodeView

property definitionLabelsView

class arelle.ModelRenderingObject.DefnMdlRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlClosedDefinitionNode

init(modelDocument)

aspectsCovered()

property conceptQname

property linkrole

property formulaAxis

property generations

property relationshipSourceQnamesAndExpressions

property linkroleExpression

property formulaAxisExpression

property generationsExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalRrelationshipSourceQnames(xpCtx, fact=None)

evalLinkrole(xpCtx, fact=None)

evalFormulaAxis(xpCtx, fact=None)

evalGenerations(xpCtx, fact=None)

cardinalityAndDepth(structuralNode, **kwargs)

lenDepth(nestedRelationships, includeSelf)

property propertyView

strctMdlRollupType

None

property abstract

property isAbstract

property parentChildOrder

property descendantArcroles

property ancestorArcroles

filteredFacts(xpCtx, facts)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

hasAspect(structuralNode, aspect)

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

aspectValue(xpCtx, aspect, inherit=True)

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

evalValueExpression(xpCtx, fact)

property definitionNodeView

property definitionLabelsView

class arelle.ModelRenderingObject.DefnMdlConceptRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlRelationshipNode

strctMdlRollupType

None

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

property isOrSelfAxis

coveredAspect(ordCntx=None)

relationships(structuralNode, **kwargs)

aspectsCovered()

property conceptQname

property linkrole

property formulaAxis

property generations

property relationshipSourceQnamesAndExpressions

property linkroleExpression

property formulaAxisExpression

property generationsExpression

evalRrelationshipSourceQnames(xpCtx, fact=None)

evalLinkrole(xpCtx, fact=None)

evalFormulaAxis(xpCtx, fact=None)

evalGenerations(xpCtx, fact=None)

cardinalityAndDepth(structuralNode, **kwargs)

lenDepth(nestedRelationships, includeSelf)

property propertyView

property abstract

property isAbstract

property parentChildOrder

property descendantArcroles

property ancestorArcroles

filteredFacts(xpCtx, facts)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

aspectValue(xpCtx, aspect, inherit=True)

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

evalValueExpression(xpCtx, fact)

property definitionNodeView

property definitionLabelsView

class arelle.ModelRenderingObject.DefnMdlDimensionRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlRelationshipNode

strctMdlRollupType

None

init(modelDocument)

hasAspect(structuralNode, aspect)

aspectValue(xpCtx, aspect, inherit=None)

aspectsCovered()

property dimensionQname

compile()

variableRefs(progs=[], varRefSet=None)

evalDimensionQname(xpCtx, fact=None)

property isOrSelfAxis

coveredAspect(structuralNode=None)

relationships(structuralNode, **kwargs)

dimRelationships(structuralNode, getMembers=False, getDimQname=False)

property conceptQname

property linkrole

property formulaAxis

property generations

property relationshipSourceQnamesAndExpressions

property linkroleExpression

property formulaAxisExpression

property generationsExpression

evalRrelationshipSourceQnames(xpCtx, fact=None)

evalLinkrole(xpCtx, fact=None)

evalFormulaAxis(xpCtx, fact=None)

evalGenerations(xpCtx, fact=None)

cardinalityAndDepth(structuralNode, **kwargs)

lenDepth(nestedRelationships, includeSelf)

property propertyView

property abstract

property isAbstract

property parentChildOrder

property descendantArcroles

property ancestorArcroles

filteredFacts(xpCtx, facts)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

evalValueExpression(xpCtx, fact)

property definitionNodeView

property definitionLabelsView

arelle.ModelRenderingObject.coveredAspectToken

None

class arelle.ModelRenderingObject.DefnMdlOpenDefinitionNode

Bases: arelle.ModelRenderingObject.DefnMdlDefinitionNode

strctMdlRollupType

None

init(modelDocument)

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

property descendantArcroles

hasAspect(structuralNode, aspect)

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

aspectValue(xpCtx, aspect, inherit=True)

aspectsCovered()

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

compile()

evalValueExpression(xpCtx, fact)

property isAbstract

cardinalityAndDepth(structuralNode, **kwargs)

property definitionNodeView

property definitionLabelsView

property parentChildOrder

arelle.ModelRenderingObject.aspectNodeAspectCovered

None

class arelle.ModelRenderingObject.DefnMdlAspectNode

Bases: arelle.ModelRenderingObject.DefnMdlOpenDefinitionNode

init(modelDocument)

property descendantArcroles

property filterRelationships

hasAspect(structuralNode, aspect)

aspectsCovered(varBinding=None)

aspectValue(xpCtx, aspect, inherit=None)

filteredFactsPartitions(xpCtx, facts)

property propertyView

strctMdlRollupType

None

property childrenCoverSameAspects

aspectModel

‘dimensional’

property isMerged

property parentTableNode

aspectValueDependsOnVars(aspect)

property variablename

property variableQname

property constraintSets

property tagSelector

property valueExpression

property hasValueExpression

compile()

evalValueExpression(xpCtx, fact)

property isAbstract

cardinalityAndDepth(structuralNode, **kwargs)

property definitionNodeView

property definitionLabelsView

property parentChildOrder