`arelle.ViewFileRelationshipSet`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

ViewRelationshipSet

Functions¶

`viewRelationshipSet`
`hasCalcArcrole`

Data¶

API¶

arelle.ViewFileRelationshipSet.viewRelationshipSet(modelXbrl: arelle.ModelXbrl.ModelXbrl, outfile: str | arelle.FileSource.FileNamedStringIO | None, header: str, arcrole: str | tuple[str, ...], linkrole: str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None, labelrole: str | None = None, lang: str | None = None, cols: list[str] | str | None = None) → None¶

arelle.ViewFileRelationshipSet.COL_WIDTHS¶: None

arelle.ViewFileRelationshipSet.hasCalcArcrole(arcroles: str | tuple[str, ...] | list[str] | tuple[str | tuple[str, ...], ...]) → bool¶

class arelle.ViewFileRelationshipSet.ViewRelationshipSet(modelXbrl: arelle.ModelXbrl.ModelXbrl, outfile: str | arelle.FileSource.FileNamedStringIO | None, header: str, labelrole: str | None, lang: str | None, cols: list[str] | str | None)¶

Bases: arelle.ViewFile.View

Initialization

view(arcrole: str | tuple[str, ...] | list[str], linkrole: str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None) → None¶

treeDepth(concept: arelle.ModelObject.ModelObject | None, modelObject: arelle.ModelObject.ModelObject | None, indent: int, arcrole: str | tuple[str, ...], relationshipSet: arelle.ModelRelationshipSet.ModelRelationshipSet, visited: set[arelle.ModelObject.ModelObject]) → None¶

viewConcept(concept: arelle.ModelObject.ModelObject | None, modelObject: arelle.ModelDtsObject.ModelRelationship | None, labelPrefix: str, preferredLabel: str | None, indent: int, arcrole: str | tuple[str, ...], relationshipSet: arelle.ModelRelationshipSet.ModelRelationshipSet, visited: set[arelle.ModelObject.ModelObject]) → None¶