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[Any]

‘set(…)’

arelle.ModelRenderingObject.EMPTY_DICT: dict[Any, Any]

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: str, message: str, **kwargs: Any)

Bases: Exception

add_note()

class args

with_traceback()

class arelle.ModelRenderingObject.LytMdlTableModel(entryPointUrl: str | None)

Initialization

class arelle.ModelRenderingObject.LytMdlTableSet(lytMdlTableModel: arelle.ModelRenderingObject.LytMdlTableModel, strctMdlTableSet: arelle.ModelRenderingObject.StrctMdlTableSet, label: str | None, srcFile: str | None, srcLine: int | None, srcLinkrole: str | None)

Initialization

class arelle.ModelRenderingObject.LytMdlTable(lytMdlTableSet: arelle.ModelRenderingObject.LytMdlTableSet, strctMdlTable: arelle.ModelRenderingObject.StrctMdlTable)

Initialization

lytMdlAxisHeaders(axis: str) → arelle.ModelRenderingObject.LytMdlHeaders | None

headerDepth(axis: str, includeOpenAspectEntrySurrogates: bool = False) → int

numBodyCells(axis: str) → int

class arelle.ModelRenderingObject.LytMdlHeaders(lytMdlTable: arelle.ModelRenderingObject.LytMdlTable, axis: str)

Initialization

class arelle.ModelRenderingObject.LytMdlGroup(lytMdlHeaders: arelle.ModelRenderingObject.LytMdlHeaders, label: str | None, srcFile: str | None, srcLine: int | None)

Initialization

class arelle.ModelRenderingObject.LytMdlHeader(lytMdlGroup: arelle.ModelRenderingObject.LytMdlGroup)

Initialization

property maxNumLabels: int

class arelle.ModelRenderingObject.LytMdlCell

Initialization

labelXmlText(iLabel: int, default: str = '') → str | None

class arelle.ModelRenderingObject.LytMdlConstraint(lytMdlCell: arelle.ModelRenderingObject.LytMdlCell, tag: str | None)

Initialization

class arelle.ModelRenderingObject.LytMdlBodyCells(lytMdlParent: arelle.ModelRenderingObject.LytMdlTable | arelle.ModelRenderingObject.LytMdlBodyCells, axis: str)

Initialization

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

Initialization

arelle.ModelRenderingObject.definitionNodes(nodes: collections.abc.Iterable[Any]) → list[Any]

arelle.ModelRenderingObject.parentChildOrder(node: arelle.ModelFormulaObject.ModelFormulaResource) → str | None

arelle.ModelRenderingObject.aspectStrctNodes(strctNode: StrctMdlNode | None) → dict[int, set[Any]]

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

Initialization

abstract: bool

None

tableNode: DefnMdlTable | None

None

aspectEntryObjectId: str

None

parentOrdinateContext: bool

None

hasOpenNode: bool

None

property axis: str

property depth: int

aspectsCovered(inherit: bool = False) → set[Any]

hasAspect(aspect: int, inherit: bool = True) → typing_extensions.Self | None

property parentChildOrder: str | None

property hasRollUpChild: bool

property tagSelectors: set[str | None]

property leafNodeCount: int

property cardinalityAndDepth: tuple[int, int]

objectId(refId: str = '') → str | None

property xlinkLabel: str | None

property structuralDepth: int

property childRollupStrctNode: arelle.ModelRenderingObject.StrctMdlNode | None

headerAndSource(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → tuple[Any, Any]

header(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → Any

property isAbstract: bool

property isEntryAspect: bool

isEntryPrototype(default: bool = False) → bool

evaluate(evalObject: arelle.ModelObject.ModelObject, evalMethod: Callable[[arelle.formula.XPathContext.XPathContext, ...], Any], otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None, evalArgs: tuple[Any, ...] = (), handleXPathException: bool = True, **kwargs: Any) → Any

hasValueExpression(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → bool

evalValueExpression(fact: Any, otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → Any

property hasBreakdownWithoutNodes: bool

class arelle.ModelRenderingObject.StrctMdlTableSet(defnMdlTable: arelle.ModelRenderingObject.DefnMdlDefinitionNode | None)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

abstract: bool

None

tableNode: DefnMdlTable | None

None

aspectEntryObjectId: str

None

parentOrdinateContext: bool

None

hasOpenNode: bool

None

property axis: str

property depth: int

aspectsCovered(inherit: bool = False) → set[Any]

hasAspect(aspect: int, inherit: bool = True) → typing_extensions.Self | None

property parentChildOrder: str | None

property hasRollUpChild: bool

property tagSelectors: set[str | None]

property leafNodeCount: int

property cardinalityAndDepth: tuple[int, int]

objectId(refId: str = '') → str | None

property xlinkLabel: str | None

property structuralDepth: int

property childRollupStrctNode: arelle.ModelRenderingObject.StrctMdlNode | None

headerAndSource(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → tuple[Any, Any]

header(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → Any

property isAbstract: bool

property isEntryAspect: bool

isEntryPrototype(default: bool = False) → bool

evaluate(evalObject: arelle.ModelObject.ModelObject, evalMethod: Callable[[arelle.formula.XPathContext.XPathContext, ...], Any], otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None, evalArgs: tuple[Any, ...] = (), handleXPathException: bool = True, **kwargs: Any) → Any

hasValueExpression(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → bool

evalValueExpression(fact: Any, otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → Any

property hasBreakdownWithoutNodes: bool

class arelle.ModelRenderingObject.StrctMdlTable(strctMdlParentNode: arelle.ModelRenderingObject.StrctMdlNode | None, defnMdlTable: arelle.ModelRenderingObject.DefnMdlDefinitionNode | None)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

strctMdlFirstAxisBreakdown(axis: str) → arelle.ModelRenderingObject.StrctMdlNode | None

abstract: bool

None

tableNode: DefnMdlTable | None

None

aspectEntryObjectId: str

None

parentOrdinateContext: bool

None

hasOpenNode: bool

None

property axis: str

property depth: int

aspectsCovered(inherit: bool = False) → set[Any]

hasAspect(aspect: int, inherit: bool = True) → typing_extensions.Self | None

property parentChildOrder: str | None

property hasRollUpChild: bool

property tagSelectors: set[str | None]

property leafNodeCount: int

property cardinalityAndDepth: tuple[int, int]

objectId(refId: str = '') → str | None

property xlinkLabel: str | None

property structuralDepth: int

property childRollupStrctNode: arelle.ModelRenderingObject.StrctMdlNode | None

headerAndSource(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → tuple[Any, Any]

header(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → Any

property isAbstract: bool

property isEntryAspect: bool

isEntryPrototype(default: bool = False) → bool

evaluate(evalObject: arelle.ModelObject.ModelObject, evalMethod: Callable[[arelle.formula.XPathContext.XPathContext, ...], Any], otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None, evalArgs: tuple[Any, ...] = (), handleXPathException: bool = True, **kwargs: Any) → Any

hasValueExpression(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → bool

evalValueExpression(fact: Any, otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → Any

property hasBreakdownWithoutNodes: bool

class arelle.ModelRenderingObject.StrctMdlBreakdown(strctMdlParentNode: arelle.ModelRenderingObject.StrctMdlNode, defnMdlBreakdown: arelle.ModelRenderingObject.DefnMdlDefinitionNode | None, axis: str)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

siblingBreakdownNode() → tuple[arelle.ModelRenderingObject.StrctMdlNode, ...]

property strctMdlAncestorBreakdownNode: typing_extensions.Self

property strctMdlEffectiveChildNodes: collections.abc.Iterable[arelle.ModelRenderingObject.StrctMdlNode]

setHasOpenNode() → None

inheritedAspectValue(*args: Any) → Any

abstract: bool

None

tableNode: DefnMdlTable | None

None

aspectEntryObjectId: str

None

parentOrdinateContext: bool

None

hasOpenNode: bool

None

property axis: str

property depth: int

aspectsCovered(inherit: bool = False) → set[Any]

hasAspect(aspect: int, inherit: bool = True) → typing_extensions.Self | None

property parentChildOrder: str | None

property hasRollUpChild: bool

property tagSelectors: set[str | None]

property leafNodeCount: int

property cardinalityAndDepth: tuple[int, int]

objectId(refId: str = '') → str | None

property xlinkLabel: str | None

property structuralDepth: int

property childRollupStrctNode: arelle.ModelRenderingObject.StrctMdlNode | None

headerAndSource(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → tuple[Any, Any]

header(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → Any

property isAbstract: bool

property isEntryAspect: bool

isEntryPrototype(default: bool = False) → bool

evaluate(evalObject: arelle.ModelObject.ModelObject, evalMethod: Callable[[arelle.formula.XPathContext.XPathContext, ...], Any], otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None, evalArgs: tuple[Any, ...] = (), handleXPathException: bool = True, **kwargs: Any) → Any

hasValueExpression(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → bool

evalValueExpression(fact: Any, otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → Any

property hasBreakdownWithoutNodes: bool

class arelle.ModelRenderingObject.StrctMdlStructuralNode(strctMdlParentNode: arelle.ModelRenderingObject.StrctMdlNode | None, defnMdlNode: arelle.ModelRenderingObject.DefnMdlDefinitionNode | None, zInheritance: Any = None, contextItemFact: Any = None, tableNode: arelle.ModelRenderingObject.DefnMdlTable | None = None, rendrCntx: arelle.formula.XPathContext.XPathContext | None = None)

Bases: arelle.ModelRenderingObject.StrctMdlNode

Initialization

property modelXbrl: arelle.ModelXbrl.ModelXbrl | None

property structuralDepth: int

siblingBreakdownNode() → tuple[arelle.ModelRenderingObject.StrctMdlNode, ...]

property strctMdlEffectiveChildNodes: collections.abc.Iterable[arelle.ModelRenderingObject.StrctMdlNode]

property strctMdlAncestorBreakdownNode: arelle.ModelRenderingObject.StrctMdlBreakdown | None

constraintSet(tagSelectors: set[str | None] | None = None) → Any

constraintTags() → list[Any] | None

aspectsCovered(inherit: bool = False) → set[int]

hasAspect(aspect: int, inherit: bool = True) → typing_extensions.Self | None

dimRAV(aspect: Any, value: Any) → Any

aspectValue(aspect: int, inherit: bool = True, dims: set[Any] | None = None, depth: int = 0, tagSelectors: set[str | None] | None = None) → Any

property tableDefinitionNode: Any

property leafNodeCount: int

setHasOpenNode() → None

inheritedAspectValue(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None, view: Any, aspect: int, tagSelectors: set[str | None] | None, xAspectStructuralNodes: dict[int, set[Any]], yAspectStructuralNodes: dict[int, set[Any]], zAspectStructuralNodes: dict[int, set[Any]]) → Any

abstract: bool

None

tableNode: DefnMdlTable | None

None

aspectEntryObjectId: str

None

parentOrdinateContext: bool

None

hasOpenNode: bool

None

property axis: str

property depth: int

property parentChildOrder: str | None

property hasRollUpChild: bool

property tagSelectors: set[str | None]

property cardinalityAndDepth: tuple[int, int]

objectId(refId: str = '') → str | None

property xlinkLabel: str | None

property childRollupStrctNode: arelle.ModelRenderingObject.StrctMdlNode | None

headerAndSource(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → tuple[Any, Any]

header(role: str | None = None, lang: str | None = None, evaluate: bool = True, returnGenLabel: bool = True, returnMsgFormatString: bool = False, recurseParent: bool = True, returnStdLabel: bool = True, layoutMdlSortOrder: bool = False) → Any

property isAbstract: bool

property isEntryAspect: bool

isEntryPrototype(default: bool = False) → bool

evaluate(evalObject: arelle.ModelObject.ModelObject, evalMethod: Callable[[arelle.formula.XPathContext.XPathContext, ...], Any], otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None, evalArgs: tuple[Any, ...] = (), handleXPathException: bool = True, **kwargs: Any) → Any

hasValueExpression(otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → bool

evalValueExpression(fact: Any, otherAxisStructuralNode: arelle.ModelRenderingObject.StrctMdlNode | None = None) → Any

property hasBreakdownWithoutNodes: bool

arelle.ModelRenderingObject.defnMdlLabelsView(mdlObj: arelle.ModelObject.ModelObject) → tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlTable

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

clear() → None

property isMerged: bool

property parentTableNode: typing_extensions.Self

property parentChildOrder: str | None

property descendantArcroles: tuple[str, ...]

property ancestorArcroles: tuple[]

property aspectModel: str

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship]

property definitionLabelsView: tuple[tuple[str, str], ...]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → Any

property renderingXPathContext: arelle.formula.XPathContext.XPathContext | None

property propertyView: tuple[tuple[str, str | None], ...]

property definitionNodeView: str

class arelle.ModelRenderingObject.DefnMdlBreakdown

Bases: arelle.ModelFormulaObject.ModelFormulaResource

strctMdlRollupType

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property isMerged: bool

hasAspect(*args: Any) → bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str]

property childrenCoverSameAspects: bool

aspectsCovered() → set[Any]

property constraintSets: dict[Any, Any]

property isAbstract: bool

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

property propertyView: tuple[tuple[str, str | None], ...]

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlDefinitionNode

Bases: arelle.ModelFormulaObject.ModelFormulaResource

aspectModel

‘dimensional’

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

property descendantArcroles: tuple[str, str]

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

(str) – name attribute

property variableQname: arelle.ModelValue.QName | None

(QName) – resolved name for an XPath bound result having a QName name attribute

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = True) → list[Any] | None

aspectsCovered() → set[Any]

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

compile() → None

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property isAbstract: bool

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

property parentChildOrder: str | None

class arelle.ModelRenderingObject.DefnMdlClosedDefinitionNode

Bases: arelle.ModelRenderingObject.DefnMdlDefinitionNode

strctMdlRollupType

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property abstract: str | None

property isAbstract: bool

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str, str, str]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → set[arelle.ModelInstanceObject.ModelFact]

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = True) → list[Any] | None

aspectsCovered() → set[Any]

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

compile() → None

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlConstraintSet

Bases: arelle.ModelFormulaObject.ModelFormulaRules

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

isMerged() → bool

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int, inherit: bool = False) → bool

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int, inherit: bool = False) → Any

aspectValueDependsOnVars(aspect: int) → bool

aspectsCovered() → set[int]

aspectsModelCovered() → set[int]

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

class arelle.ModelRenderingObject.DefnMdlRuleSet

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

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property tagName: str | None

isMerged() → bool

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int, inherit: bool = False) → bool

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int, inherit: bool = False) → Any

aspectValueDependsOnVars(aspect: int) → bool

aspectsCovered() → set[int]

aspectsModelCovered() → set[int]

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

class arelle.ModelRenderingObject.DefnMdlRuleDefinitionNode

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

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property merge: str | None

property isMerged: bool

property constraintSets: dict[str | None, arelle.ModelObject.ModelObject | typing_extensions.Self]

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int, inherit: bool = False) → bool

property aspectsInTaggedConstraintSet: set[int]

compile() → None

property propertyView: tuple[tuple[str, str | None], ...]

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int, inherit: bool = False) → Any

aspectValueDependsOnVars(aspect: int) → bool

aspectsCovered() → set[int]

aspectsModelCovered() → set[int]

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

strctMdlRollupType

None

property abstract: str | None

property isAbstract: bool

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str, str, str]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → set[arelle.ModelInstanceObject.ModelFact]

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlClosedDefinitionNode

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

aspectsCovered() → set[int]

property conceptQname: arelle.ModelValue.QName | None

property linkrole: str | None

property formulaAxis: str | None

property generations: int

property relationshipSourceQnamesAndExpressions: list[str | arelle.ModelValue.QName | None]

property linkroleExpression: str | None

property formulaAxisExpression: str | None

property generationsExpression: str | None

compile() → None

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]

evalRrelationshipSourceQnames(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → list[Any]

evalLinkrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalFormulaAxis(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalGenerations(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

lenDepth(nestedRelationships: collections.abc.Iterable[Any], includeSelf: bool) → tuple[int, int]

property propertyView: tuple[tuple[str, str | None], ...]

strctMdlRollupType

None

property abstract: str | None

property isAbstract: bool

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str, str, str]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → set[arelle.ModelInstanceObject.ModelFact]

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = True) → list[Any] | None

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlConceptRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlRelationshipNode

strctMdlRollupType

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

property arcrole: str | None

property arcQname: arelle.ModelValue.QName | None

property linkQname: arelle.ModelValue.QName | None

compile() → None

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]

evalArcrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalLinkQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalArcQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

property arcroleExpression: str | None

property linkQnameExpression: str | None

property arcQnameExpression: str | None

property isOrSelfAxis: bool

coveredAspect(ordCntx: arelle.formula.XPathContext.XPathContext | None = None) → int

relationships(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → list[Any]

aspectsCovered() → set[int]

property conceptQname: arelle.ModelValue.QName | None

property linkrole: str | None

property formulaAxis: str | None

property generations: int

property relationshipSourceQnamesAndExpressions: list[str | arelle.ModelValue.QName | None]

property linkroleExpression: str | None

property formulaAxisExpression: str | None

property generationsExpression: str | None

evalRrelationshipSourceQnames(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → list[Any]

evalLinkrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalFormulaAxis(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalGenerations(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

lenDepth(nestedRelationships: collections.abc.Iterable[Any], includeSelf: bool) → tuple[int, int]

property propertyView: tuple[tuple[str, str | None], ...]

property abstract: str | None

property isAbstract: bool

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str, str, str]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → set[arelle.ModelInstanceObject.ModelFact]

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = True) → list[Any] | None

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

class arelle.ModelRenderingObject.DefnMdlDimensionRelationshipNode

Bases: arelle.ModelRenderingObject.DefnMdlRelationshipNode

strctMdlRollupType

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = False) → Any

aspectsCovered() → set[arelle.ModelValue.QName | None]

property dimensionQname: arelle.ModelValue.QName | None

compile() → None

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]

evalDimensionQname(xpCtx: Any, fact: Any = None) → arelle.ModelValue.QName | None

property isOrSelfAxis: bool

coveredAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode | None = None) → Any

relationships(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, **kwargs: Any) → Any

dimRelationships(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, getMembers: bool = False, getDimQname: bool = False) → Any

property conceptQname: arelle.ModelValue.QName | None

property linkrole: str | None

property formulaAxis: str | None

property generations: int

property relationshipSourceQnamesAndExpressions: list[str | arelle.ModelValue.QName | None]

property linkroleExpression: str | None

property formulaAxisExpression: str | None

property generationsExpression: str | None

evalRrelationshipSourceQnames(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → list[Any]

evalLinkrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalFormulaAxis(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

evalGenerations(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem = None) → Any

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

lenDepth(nestedRelationships: collections.abc.Iterable[Any], includeSelf: bool) → tuple[int, int]

property propertyView: tuple[tuple[str, str | None], ...]

property abstract: str | None

property isAbstract: bool

property parentChildOrder: str | None

property descendantArcroles: tuple[str, str]

property ancestorArcroles: tuple[str, str, str, str]

filteredFacts(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → set[arelle.ModelInstanceObject.ModelFact]

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

arelle.ModelRenderingObject.coveredAspectToken

None

class arelle.ModelRenderingObject.DefnMdlOpenDefinitionNode

Bases: arelle.ModelRenderingObject.DefnMdlDefinitionNode

strctMdlRollupType

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

property descendantArcroles: tuple[str, str]

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = True) → list[Any] | None

aspectsCovered() → set[Any]

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

compile() → None

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property isAbstract: bool

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

property parentChildOrder: str | None

arelle.ModelRenderingObject.aspectNodeAspectCovered

None

class arelle.ModelRenderingObject.DefnMdlAspectNode

Bases: arelle.ModelRenderingObject.DefnMdlOpenDefinitionNode

includeUnreportedValue: bool

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None

property descendantArcroles: tuple[str, str, str, str]

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship | arelle.ModelFormulaObject.ModelConceptName]

hasAspect(structuralNode: arelle.ModelRenderingObject.StrctMdlStructuralNode, aspect: int) → bool

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding | None = None) → set[int | arelle.ModelValue.QName]

aspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: int, inherit: bool = False) → set[arelle.ModelValue.QName] | None

filteredFactsPartitions(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → Any

property propertyView: tuple[tuple[str, str | None], ...]

strctMdlRollupType

None

property childrenCoverSameAspects: bool

aspectModel

‘dimensional’

property isMerged: bool

property parentTableNode: arelle.ModelRenderingObject.DefnMdlTable | None

aspectValueDependsOnVars(aspect: Any) → bool

property variablename: str | None

property variableQname: arelle.ModelValue.QName | None

property constraintSets: dict[None, typing_extensions.Self]

property tagSelector: str | None

property valueExpression: str | None

property hasValueExpression: bool

compile() → None

evalValueExpression(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.formula.XPathContext.ContextItem) → Any

property isAbstract: bool

cardinalityAndDepth(structuralNode: arelle.ModelRenderingObject.StrctMdlNode, **kwargs: Any) → tuple[int, int]

property definitionNodeView: str

property definitionLabelsView: tuple[tuple[str, str], ...]

property parentChildOrder: str | None