`arelle.ModelRelationshipSet`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

ModelRelationshipSet

Functions¶

`create`
`ineffectiveArcs`
`baseSetRelationship`

Data¶

`USING_EQUIVALENCE_KEY`
`NoneType`

API¶

arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY¶: ‘intern(…)’

arelle.ModelRelationshipSet.NoneType¶: ‘type(…)’

arelle.ModelRelationshipSet.create(modelXbrl: arelle.ModelXbrl.ModelXbrl, arcrole: tuple[str, ...] | str, linkrole: tuple[str, ...] | str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None, includeProhibits: bool = False) → ModelRelationshipSet¶

arelle.ModelRelationshipSet.ineffectiveArcs(baseSetModelLinks: list[arelle.ModelDtsObject.ModelLink | arelle.PrototypeDtsObject.LinkPrototype], arcrole: tuple[str, ...] | str, arcqname: arelle.ModelValue.QName | None = None) → list[arelle.ModelDtsObject.ModelRelationship]¶

arelle.ModelRelationshipSet.baseSetRelationship(arcElement: arelle.ModelObject.ModelObject) → arelle.ModelDtsObject.ModelRelationship | None¶

class arelle.ModelRelationshipSet.ModelRelationshipSet(modelXbrl: arelle.ModelXbrl.ModelXbrl, arcrole: tuple[str, ...] | str, linkrole: tuple[str, ...] | str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None, includeProhibits: bool = False)¶

Initialization

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

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

clear() → None¶

contains(modelObject: arelle.ModelObject.ModelObject) → bool¶

property linkRoleUris: arelle.PythonUtil.OrderedSet[str]¶

loadModelRelationshipsFrom() → dict[arelle.ModelObject.ModelObject, list[arelle.ModelDtsObject.ModelRelationship]]¶

loadModelRelationshipsTo() → dict[arelle.ModelObject.ModelObject, list[arelle.ModelDtsObject.ModelRelationship]]¶

fromModelObjects() → dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]¶

fromModelObject(modelFrom: arelle.ModelObject.ModelObject) → list[arelle.ModelDtsObject.ModelRelationship]¶

toModelObjects() → dict[Any, list[arelle.ModelDtsObject.ModelRelationship]]¶

toModelObject(modelTo: arelle.ModelObject.ModelObject) → list[arelle.ModelDtsObject.ModelRelationship]¶

fromToModelObjects(modelFrom: arelle.ModelObject.ModelObject, modelTo: arelle.ModelObject.ModelObject, checkBothDirections: bool = False) → list[arelle.ModelDtsObject.ModelRelationship]¶

property rootConcepts: list[arelle.ModelObject.ModelObject]¶

isRelated(modelFrom: arelle.ModelObject.ModelObject, axis: str, modelTo: arelle.ModelObject.ModelObject | None = None, visited: set[arelle.ModelObject.ModelObject] | None = None, isDRS: bool = False, consecutiveLinkrole: bool = False) → bool¶

label(modelFrom: arelle.ModelObject.ModelObject, role: str, lang: str | None, returnMultiple: bool = False, returnText: bool = True, linkroleHint: str | None = None) → str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None¶

arelle.ModelRelationshipSet¶