arelle.ModelVersObject

See COPYRIGHT.md for copyright information.

Module Contents

Classes

ModelVersObject

ModelAssignment

ModelAction

ModelUriMapped

ModelNamespaceRename

ModelRoleChange

ModelConceptChange

ModelConceptUseChange

ModelConceptDetailsChange

ModelRelationshipSetChange

ModelRelationshipSet

ModelRelationships

ModelInstanceAspectsChange

ModelInstanceAspects

ModelInstanceAspect

ModelConceptsDimsAspect

ModelPeriodAspect

ModelMeasureAspect

ModelRelatedConcept

ModelAspectProperty

Functions

relateConceptMdlObjs

API

arelle.ModelVersObject.relateConceptMdlObjs(modelDocument: arelle.ModelVersReport.ModelVersReport, fromConceptMdlObjs: list[ModelConceptChange], toConceptMdlObjs: list[ModelConceptChange]) → None
class arelle.ModelVersObject.ModelVersObject

Bases: arelle.ModelObject.ModelObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelAssignment

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property categoryqname: str | None
property categoryQName: str | None
property propertyView: tuple[tuple[str, str | None], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelAction

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property assignmentRefs: list[str]
property propertyView: tuple[tuple[str, str | list[str] | None], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelUriMapped

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property fromURI: str | None
property toURI: str | None
property propertyView: tuple[tuple[str, str | None], ...]
viewText(labelrole: str | None = None, lang: str | None = None) → str
property name: str
class arelle.ModelVersObject.ModelNamespaceRename

Bases: arelle.ModelVersObject.ModelUriMapped

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property fromURI: str | None
property toURI: str | None
property propertyView: tuple[tuple[str, str | None], ...]
viewText(labelrole: str | None = None, lang: str | None = None) → str
property name: str
class arelle.ModelVersObject.ModelRoleChange

Bases: arelle.ModelVersObject.ModelUriMapped

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property fromURI: str | None
property toURI: str | None
property propertyView: tuple[tuple[str, str | None], ...]
viewText(labelrole: str | None = None, lang: str | None = None) → str
property name: str
class arelle.ModelVersObject.ModelConceptChange

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property actionId: str | None
property physical: str
property isPhysical: bool
property fromConceptQname: arelle.ModelValue.QName | None
property toConceptQname: arelle.ModelValue.QName | None
property fromConcept: arelle.ModelDtsObject.ModelConcept | None
property toConcept: arelle.ModelDtsObject.ModelConcept | None
setConceptEquivalence() → None
property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]
viewText(labelrole: str | None = XbrlConst.conceptNameLabelRole, lang: str | None = None) → str | None
property name: str
class arelle.ModelVersObject.ModelConceptUseChange

Bases: arelle.ModelVersObject.ModelConceptChange

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property actionId: str | None
property physical: str
property isPhysical: bool
property fromConceptQname: arelle.ModelValue.QName | None
property toConceptQname: arelle.ModelValue.QName | None
property fromConcept: arelle.ModelDtsObject.ModelConcept | None
property toConcept: arelle.ModelDtsObject.ModelConcept | None
setConceptEquivalence() → None
property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]
viewText(labelrole: str | None = XbrlConst.conceptNameLabelRole, lang: str | None = None) → str | None
property name: str
class arelle.ModelVersObject.ModelConceptDetailsChange

Bases: arelle.ModelVersObject.ModelConceptChange

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
customAttributeQname(eventName: str) → arelle.ModelValue.QName | None
property fromCustomAttributeQname: arelle.ModelValue.QName | None
property toCustomAttributeQname: arelle.ModelValue.QName | None
property fromResourceValue: str | None
property toResourceValue: str | None
property fromResource: arelle.ModelObject.ModelObject | None
property toResource: arelle.ModelObject.ModelObject | None
property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]
property actionId: str | None
property physical: str
property isPhysical: bool
property fromConceptQname: arelle.ModelValue.QName | None
property toConceptQname: arelle.ModelValue.QName | None
property fromConcept: arelle.ModelDtsObject.ModelConcept | None
property toConcept: arelle.ModelDtsObject.ModelConcept | None
setConceptEquivalence() → None
viewText(labelrole: str | None = XbrlConst.conceptNameLabelRole, lang: str | None = None) → str | None
property name: str
class arelle.ModelVersObject.ModelRelationshipSetChange

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property propertyView: tuple[tuple[str, str]]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelRelationshipSet

Bases: arelle.ModelVersObject.ModelVersObject

modelRelationshipSetEvent: arelle.ModelVersObject.ModelRelationshipSetChange

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property isFromDTS: bool
property dts: arelle.ModelXbrl.ModelXbrl
property relationshipSetElement: arelle.ModelObject.ModelObject | None
property linkrole: str | None
property arc: arelle.ModelValue.QName | None
property arcrole: str | None
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelRelationships

Bases: arelle.ModelVersObject.ModelVersObject

modelRelationshipSet: arelle.ModelVersObject.ModelRelationshipSet

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property fromName: arelle.ModelValue.QName | None
property toName: arelle.ModelValue.QName | None
property fromConcept: arelle.ModelDtsObject.ModelConcept | None
property toConcept: arelle.ModelDtsObject.ModelConcept | None
property axis: str | None
property isFromDTS: bool
property fromRelationships: list[arelle.ModelDtsObject.ModelRelationship] | None
property fromRelationship: arelle.ModelDtsObject.ModelRelationship | None
property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelInstanceAspectsChange

Bases: arelle.ModelVersObject.ModelVersObject

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property propertyView: tuple[tuple[str, str]]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelInstanceAspects

Bases: arelle.ModelVersObject.ModelVersObject

aspectModelEvent: arelle.ModelVersObject.ModelInstanceAspectsChange

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property isFromDTS: bool
property dts: arelle.ModelXbrl.ModelXbrl
property excluded: str | None
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelInstanceAspect

Bases: arelle.ModelVersObject.ModelVersObject

modelAspects: arelle.ModelVersObject.ModelInstanceAspects

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property isFromDTS: bool
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelConceptsDimsAspect

Bases: arelle.ModelVersObject.ModelInstanceAspect

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property conceptName: arelle.ModelValue.QName | None
property concept: arelle.ModelDtsObject.ModelConcept | None
property sourceDtsObject: arelle.ModelDtsObject.ModelConcept | None
modelAspects: arelle.ModelVersObject.ModelInstanceAspects

None

property isFromDTS: bool
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelPeriodAspect

Bases: arelle.ModelVersObject.ModelInstanceAspect

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
modelAspects: arelle.ModelVersObject.ModelInstanceAspects

None

property isFromDTS: bool
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelMeasureAspect

Bases: arelle.ModelVersObject.ModelInstanceAspect

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
modelAspects: arelle.ModelVersObject.ModelInstanceAspects

None

property isFromDTS: bool
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelRelatedConcept

Bases: arelle.ModelVersObject.ModelVersObject

modelAspect: arelle.ModelVersObject.ModelInstanceAspect

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property conceptName: arelle.ModelValue.QName | None
property concept: arelle.ModelDtsObject.ModelConcept | None
property sourceDtsObject: arelle.ModelDtsObject.ModelConcept | None
property isFromDTS: bool
property hasNetwork: bool
property hasDrsNetwork: bool
property arcrole: str | None
property linkrole: str | None
property arc: arelle.ModelValue.QName | None
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str
class arelle.ModelVersObject.ModelAspectProperty

Bases: arelle.ModelVersObject.ModelVersObject

modelAspect: arelle.ModelVersObject.ModelInstanceAspect

None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None
property propertyView: tuple[tuple[str, str | None] | tuple[], ...]
property name: str
viewText(labelrole: str | None = None, lang: str | None = None) → str