arelle.ModelRelationshipSet

See COPYRIGHT.md for copyright information.

Module Contents

Classes

Functions

Data

API

arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY

‘intern(…)’

arelle.ModelRelationshipSet.NoneType

‘type(…)’

arelle.ModelRelationshipSet.create(modelXbrl, arcrole, linkrole=None, linkqname=None, arcqname=None, includeProhibits=False) ModelRelationshipSet
arelle.ModelRelationshipSet.ineffectiveArcs(baseSetModelLinks, arcrole, arcqname=None)
arelle.ModelRelationshipSet.baseSetArcroles(modelXbrl)
arelle.ModelRelationshipSet.labelroles(modelXbrl, includeConceptName=False)
arelle.ModelRelationshipSet.baseSetRelationship(arcElement)
class arelle.ModelRelationshipSet._LangLabels
lang: str

None

labels: list[arelle.ModelObject.ModelObject] | list[str]

None

class arelle.ModelRelationshipSet.ModelRelationshipSet(modelXbrl, arcrole, linkrole=None, linkqname=None, arcqname=None, includeProhibits=False)

Initialization

__slots__

(‘isChanged’, ‘modelXbrl’, ‘arcrole’, ‘linkrole’, ‘linkqname’, ‘arcqname’, ‘modelRelationshipsFrom’,…

modelRelationshipsFrom: dict[Any, list[arelle.ModelDtsObject.ModelRelationship]] | None

None

modelRelationshipsTo: dict[Any, list[arelle.ModelDtsObject.ModelRelationship]] | None

None

clear() None
__bool__()
property linkRoleUris
loadModelRelationshipsFrom() dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]
loadModelRelationshipsTo() dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]
fromModelObjects() dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]
fromModelObject(modelFrom) list[arelle.ModelDtsObject.ModelRelationship]
toModelObjects() dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]
toModelObject(modelTo) list[arelle.ModelDtsObject.ModelRelationship]
fromToModelObjects(modelFrom, modelTo, checkBothDirections=False) list[arelle.ModelDtsObject.ModelRelationship]
property rootConcepts
isRelated(modelFrom, axis, modelTo=None, visited=None, isDRS=False, consecutiveLinkrole=False)
label(modelFrom, role, lang, returnMultiple=False, returnText=True, linkroleHint=None) str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None