# {py:mod}`arelle.ModelDtsObject` ```{py:module} arelle.ModelDtsObject ``` ```{autodoc2-docstring} arelle.ModelDtsObject :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`AllowsNamespaceMixin ` - * - {py:obj}`ModelRoleType ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType :summary: ``` * - {py:obj}`ModelNamableTerm ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm :summary: ``` * - {py:obj}`ParticlesList ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ParticlesList :summary: ``` * - {py:obj}`ModelParticle ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle :summary: ``` * - {py:obj}`ModelConcept ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept :summary: ``` * - {py:obj}`ModelAttribute ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute :summary: ``` * - {py:obj}`ModelAttributeGroup ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup :summary: ``` * - {py:obj}`ModelType ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType :summary: ``` * - {py:obj}`ModelGroupDefinition ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupDefinition :summary: ``` * - {py:obj}`ModelGroupCompositor ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupCompositor :summary: ``` * - {py:obj}`ModelAll ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAll :summary: ``` * - {py:obj}`ModelChoice ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelChoice :summary: ``` * - {py:obj}`ModelSequence ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelSequence :summary: ``` * - {py:obj}`ModelAny ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAny :summary: ``` * - {py:obj}`ModelAnyAttribute ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAnyAttribute :summary: ``` * - {py:obj}`ModelEnumeration ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelEnumeration :summary: ``` * - {py:obj}`ModelLink ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLink :summary: ``` * - {py:obj}`ModelResource ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource :summary: ``` * - {py:obj}`ModelLocator ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLocator :summary: ``` * - {py:obj}`RelationStatus ` - ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus :summary: ``` * - {py:obj}`ModelRelationship ` - ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`anonymousTypeSuffix ` - ```{autodoc2-docstring} arelle.ModelDtsObject.anonymousTypeSuffix :summary: ``` * - {py:obj}`arcCustAttrsExclusions ` - ```{autodoc2-docstring} arelle.ModelDtsObject.arcCustAttrsExclusions :summary: ``` * - {py:obj}`modelObjectAttrs ` - ```{autodoc2-docstring} arelle.ModelDtsObject.modelObjectAttrs :summary: ``` * - {py:obj}`DECIMAL_1_0 ` - ```{autodoc2-docstring} arelle.ModelDtsObject.DECIMAL_1_0 :summary: ``` ```` ### API `````{py:class} AllowsNamespaceMixin :canonical: arelle.ModelDtsObject.AllowsNamespaceMixin Bases: {py:obj}`abc.ABC` ````{py:method} allowsNamespace(namespaceURI: str | None) -> bool :canonical: arelle.ModelDtsObject.AllowsNamespaceMixin.allowsNamespace ```{autodoc2-docstring} arelle.ModelDtsObject.AllowsNamespaceMixin.allowsNamespace ``` ```` ````` `````{py:class} ModelRoleType :canonical: arelle.ModelDtsObject.ModelRoleType Bases: {py:obj}`arelle.ModelObject.ModelObject` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelRoleType.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.init ``` ```` ````{py:property} isArcrole :canonical: arelle.ModelDtsObject.ModelRoleType.isArcrole :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.isArcrole ``` ```` ````{py:property} roleURI :canonical: arelle.ModelDtsObject.ModelRoleType.roleURI :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.roleURI ``` ```` ````{py:property} arcroleURI :canonical: arelle.ModelDtsObject.ModelRoleType.arcroleURI :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.arcroleURI ``` ```` ````{py:property} cyclesAllowed :canonical: arelle.ModelDtsObject.ModelRoleType.cyclesAllowed :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.cyclesAllowed ``` ```` ````{py:property} definition :canonical: arelle.ModelDtsObject.ModelRoleType.definition :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.definition ``` ```` ````{py:property} definitionNotStripped :canonical: arelle.ModelDtsObject.ModelRoleType.definitionNotStripped :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.definitionNotStripped ``` ```` ````{py:property} usedOns :canonical: arelle.ModelDtsObject.ModelRoleType.usedOns :type: set[arelle.ModelValue.TypeXValue] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.usedOns ``` ```` ````{py:property} tableCode :canonical: arelle.ModelDtsObject.ModelRoleType.tableCode :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.tableCode ``` ```` ````{py:property} propertyView :canonical: arelle.ModelDtsObject.ModelRoleType.propertyView :type: tuple[tuple[str, typing.Any], ...] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.propertyView ``` ```` ````{py:property} viewConcept :canonical: arelle.ModelDtsObject.ModelRoleType.viewConcept :type: typing_extensions.Self ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRoleType.viewConcept ``` ```` ````` `````{py:class} ModelNamableTerm :canonical: arelle.ModelDtsObject.ModelNamableTerm Bases: {py:obj}`arelle.ModelObject.ModelObject` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelNamableTerm.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm.init ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelNamableTerm.name :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm.name ``` ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelNamableTerm.qname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm.qname ``` ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelNamableTerm.isGlobalDeclaration :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm.isGlobalDeclaration ``` ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelNamableTerm.schemaNameQname ```{autodoc2-docstring} arelle.ModelDtsObject.ModelNamableTerm.schemaNameQname ``` ```` ````` `````{py:class} ParticlesList() :canonical: arelle.ModelDtsObject.ParticlesList Bases: {py:obj}`list` ```{autodoc2-docstring} arelle.ModelDtsObject.ParticlesList ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.ModelDtsObject.ParticlesList.__init__ ``` ````{py:method} append() :canonical: arelle.ModelDtsObject.ParticlesList.append ```` ````{py:method} clear() :canonical: arelle.ModelDtsObject.ParticlesList.clear ```` ````{py:method} copy() :canonical: arelle.ModelDtsObject.ParticlesList.copy ```` ````{py:method} count() :canonical: arelle.ModelDtsObject.ParticlesList.count ```` ````{py:method} extend() :canonical: arelle.ModelDtsObject.ParticlesList.extend ```` ````{py:method} index() :canonical: arelle.ModelDtsObject.ParticlesList.index ```` ````{py:method} insert() :canonical: arelle.ModelDtsObject.ParticlesList.insert ```` ````{py:method} pop() :canonical: arelle.ModelDtsObject.ParticlesList.pop ```` ````{py:method} remove() :canonical: arelle.ModelDtsObject.ParticlesList.remove ```` ````{py:method} reverse() :canonical: arelle.ModelDtsObject.ParticlesList.reverse ```` ````{py:method} sort() :canonical: arelle.ModelDtsObject.ParticlesList.sort ```` ````` `````{py:class} ModelParticle :canonical: arelle.ModelDtsObject.ModelParticle Bases: {py:obj}`abc.ABC` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle ``` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelParticle.particlesList :type: list[typing_extensions.Self] :value: > None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.particlesList ``` ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelParticle.getparent :abstractmethod: ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.getparent ``` ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelParticle.addToParticles ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.addToParticles ``` ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelParticle.maxOccurs :type: int ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.maxOccurs ``` ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelParticle.maxOccursStr :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.maxOccursStr ``` ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelParticle.minOccurs :type: int ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.minOccurs ``` ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelParticle.minOccursStr :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelParticle.minOccursStr ``` ```` ````` ````{py:data} anonymousTypeSuffix :canonical: arelle.ModelDtsObject.anonymousTypeSuffix :value: > '@anonymousType' ```{autodoc2-docstring} arelle.ModelDtsObject.anonymousTypeSuffix ``` ```` `````{py:class} ModelConcept :canonical: arelle.ModelDtsObject.ModelConcept Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm`, {py:obj}`arelle.ModelDtsObject.ModelParticle` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelConcept.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.init ``` ```` ````{py:property} abstract :canonical: arelle.ModelDtsObject.ModelConcept.abstract :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.abstract ``` ```` ````{py:property} isAbstract :canonical: arelle.ModelDtsObject.ModelConcept.isAbstract :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isAbstract ``` ```` ````{py:property} periodType :canonical: arelle.ModelDtsObject.ModelConcept.periodType :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.periodType ``` ```` ````{py:property} balance :canonical: arelle.ModelDtsObject.ModelConcept.balance :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.balance ``` ```` ````{py:property} typeQname :canonical: arelle.ModelDtsObject.ModelConcept.typeQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.typeQname ``` ```` ````{py:property} niceType :canonical: arelle.ModelDtsObject.ModelConcept.niceType :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.niceType ``` ```` ````{py:property} baseXsdType :canonical: arelle.ModelDtsObject.ModelConcept.baseXsdType :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.baseXsdType ``` ```` ````{py:property} facets :canonical: arelle.ModelDtsObject.ModelConcept.facets :type: dict[str, typing.Any] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.facets ``` ```` ````{py:property} baseXbrliType :canonical: arelle.ModelDtsObject.ModelConcept.baseXbrliType :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.baseXbrliType ``` ```` ````{py:property} baseXbrliTypeQname :canonical: arelle.ModelDtsObject.ModelConcept.baseXbrliTypeQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.baseXbrliTypeQname ``` ```` ````{py:method} instanceOfType(typeqname: arelle.ModelValue.QName | collections.abc.Collection[arelle.ModelValue.QName]) -> bool :canonical: arelle.ModelDtsObject.ModelConcept.instanceOfType ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.instanceOfType ``` ```` ````{py:property} isNumeric :canonical: arelle.ModelDtsObject.ModelConcept.isNumeric :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isNumeric ``` ```` ````{py:property} isDecimal :canonical: arelle.ModelDtsObject.ModelConcept.isDecimal :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isDecimal ``` ```` ````{py:property} isInteger :canonical: arelle.ModelDtsObject.ModelConcept.isInteger :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isInteger ``` ```` ````{py:property} isFraction :canonical: arelle.ModelDtsObject.ModelConcept.isFraction :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isFraction ``` ```` ````{py:property} isMonetary :canonical: arelle.ModelDtsObject.ModelConcept.isMonetary :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isMonetary ``` ```` ````{py:property} isShares :canonical: arelle.ModelDtsObject.ModelConcept.isShares :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isShares ``` ```` ````{py:property} isTextBlock :canonical: arelle.ModelDtsObject.ModelConcept.isTextBlock :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isTextBlock ``` ```` ````{py:property} isLanguage :canonical: arelle.ModelDtsObject.ModelConcept.isLanguage :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isLanguage ``` ```` ````{py:property} type :canonical: arelle.ModelDtsObject.ModelConcept.type :type: arelle.ModelDtsObject.ModelType | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.type ``` ```` ````{py:property} substitutionGroup :canonical: arelle.ModelDtsObject.ModelConcept.substitutionGroup :type: arelle.ModelDtsObject.ModelConcept | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.substitutionGroup ``` ```` ````{py:property} substitutionGroupQname :canonical: arelle.ModelDtsObject.ModelConcept.substitutionGroupQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.substitutionGroupQname ``` ```` ````{py:property} substitutionGroupQnames :canonical: arelle.ModelDtsObject.ModelConcept.substitutionGroupQnames :type: list[arelle.ModelValue.QName] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.substitutionGroupQnames ``` ```` ````{py:property} isQualifiedForm :canonical: arelle.ModelDtsObject.ModelConcept.isQualifiedForm :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isQualifiedForm ``` ```` ````{py:property} nillable :canonical: arelle.ModelDtsObject.ModelConcept.nillable :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.nillable ``` ```` ````{py:property} isNillable :canonical: arelle.ModelDtsObject.ModelConcept.isNillable :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isNillable ``` ```` ````{py:property} block :canonical: arelle.ModelDtsObject.ModelConcept.block :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.block ``` ```` ````{py:property} default :canonical: arelle.ModelDtsObject.ModelConcept.default :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.default ``` ```` ````{py:property} fixed :canonical: arelle.ModelDtsObject.ModelConcept.fixed :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.fixed ``` ```` ````{py:property} final :canonical: arelle.ModelDtsObject.ModelConcept.final :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.final ``` ```` ````{py:property} isRoot :canonical: arelle.ModelDtsObject.ModelConcept.isRoot :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isRoot ``` ```` ````{py:method} label(preferredLabel: str | None = None, fallbackToQname: bool = True, lang: str | tuple[str, ...] | list[str] | None = None, strip: bool = False, linkrole: str | None = None, linkroleHint: str | None = None) -> str | None :canonical: arelle.ModelDtsObject.ModelConcept.label ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.label ``` ```` ````{py:method} relationshipToResource(resourceObject: arelle.ModelObject.ModelObject, arcrole: str) -> arelle.ModelDtsObject.ModelRelationship | None :canonical: arelle.ModelDtsObject.ModelConcept.relationshipToResource ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.relationshipToResource ``` ```` ````{py:property} isItem :canonical: arelle.ModelDtsObject.ModelConcept.isItem :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isItem ``` ```` ````{py:property} isTuple :canonical: arelle.ModelDtsObject.ModelConcept.isTuple :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isTuple ``` ```` ````{py:property} isLinkPart :canonical: arelle.ModelDtsObject.ModelConcept.isLinkPart :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isLinkPart ``` ```` ````{py:property} isPrimaryItem :canonical: arelle.ModelDtsObject.ModelConcept.isPrimaryItem :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isPrimaryItem ``` ```` ````{py:property} isDomainMember :canonical: arelle.ModelDtsObject.ModelConcept.isDomainMember :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isDomainMember ``` ```` ````{py:property} isHypercubeItem :canonical: arelle.ModelDtsObject.ModelConcept.isHypercubeItem :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isHypercubeItem ``` ```` ````{py:property} isDimensionItem :canonical: arelle.ModelDtsObject.ModelConcept.isDimensionItem :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isDimensionItem ``` ```` ````{py:property} isTypedDimension :canonical: arelle.ModelDtsObject.ModelConcept.isTypedDimension :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isTypedDimension ``` ```` ````{py:property} isExplicitDimension :canonical: arelle.ModelDtsObject.ModelConcept.isExplicitDimension :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isExplicitDimension ``` ```` ````{py:property} typedDomainRef :canonical: arelle.ModelDtsObject.ModelConcept.typedDomainRef :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.typedDomainRef ``` ```` ````{py:property} typedDomainElement :canonical: arelle.ModelDtsObject.ModelConcept.typedDomainElement :type: arelle.ModelObject.ModelObject | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.typedDomainElement ``` ```` ````{py:property} isEnumeration :canonical: arelle.ModelDtsObject.ModelConcept.isEnumeration :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isEnumeration ``` ```` ````{py:property} isEnumeration2Item :canonical: arelle.ModelDtsObject.ModelConcept.isEnumeration2Item :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isEnumeration2Item ``` ```` ````{py:property} enumDomainQname :canonical: arelle.ModelDtsObject.ModelConcept.enumDomainQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.enumDomainQname ``` ```` ````{py:property} enumDomain :canonical: arelle.ModelDtsObject.ModelConcept.enumDomain :type: arelle.ModelDtsObject.ModelConcept | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.enumDomain ``` ```` ````{py:property} enumLinkrole :canonical: arelle.ModelDtsObject.ModelConcept.enumLinkrole :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.enumLinkrole ``` ```` ````{py:property} enumDomainUsable :canonical: arelle.ModelDtsObject.ModelConcept.enumDomainUsable :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.enumDomainUsable ``` ```` ````{py:property} isEnumDomainUsable :canonical: arelle.ModelDtsObject.ModelConcept.isEnumDomainUsable :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.isEnumDomainUsable ``` ```` ````{py:method} substitutesForQname(subsQname: arelle.ModelValue.QName) -> bool :canonical: arelle.ModelDtsObject.ModelConcept.substitutesForQname ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.substitutesForQname ``` ```` ````{py:property} subGroupHeadQname :canonical: arelle.ModelDtsObject.ModelConcept.subGroupHeadQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.subGroupHeadQname ``` ```` ````{py:method} dereference() -> typing_extensions.Self | arelle.ModelDtsObject.ModelConcept | None :canonical: arelle.ModelDtsObject.ModelConcept.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.dereference ``` ```` ````{py:property} propertyView :canonical: arelle.ModelDtsObject.ModelConcept.propertyView :type: tuple[tuple[str, ...]] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.propertyView ``` ```` ````{py:property} viewConcept :canonical: arelle.ModelDtsObject.ModelConcept.viewConcept :type: typing_extensions.Self ```{autodoc2-docstring} arelle.ModelDtsObject.ModelConcept.viewConcept ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelConcept.name :type: str | None ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelConcept.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelConcept.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelConcept.schemaNameQname ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelConcept.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelConcept.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelConcept.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelConcept.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelConcept.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelConcept.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelConcept.minOccursStr :type: str ```` ````` `````{py:class} ModelAttribute :canonical: arelle.ModelDtsObject.ModelAttribute Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelAttribute.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.init ``` ```` ````{py:property} typeQname :canonical: arelle.ModelDtsObject.ModelAttribute.typeQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.typeQname ``` ```` ````{py:property} type :canonical: arelle.ModelDtsObject.ModelAttribute.type :type: arelle.ModelDtsObject.ModelType | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.type ``` ```` ````{py:property} baseXsdType :canonical: arelle.ModelDtsObject.ModelAttribute.baseXsdType :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.baseXsdType ``` ```` ````{py:property} facets :canonical: arelle.ModelDtsObject.ModelAttribute.facets :type: dict[str, typing.Any] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.facets ``` ```` ````{py:property} isNumeric :canonical: arelle.ModelDtsObject.ModelAttribute.isNumeric :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.isNumeric ``` ```` ````{py:property} isQualifiedForm :canonical: arelle.ModelDtsObject.ModelAttribute.isQualifiedForm :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.isQualifiedForm ``` ```` ````{py:property} isRequired :canonical: arelle.ModelDtsObject.ModelAttribute.isRequired :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.isRequired ``` ```` ````{py:property} default :canonical: arelle.ModelDtsObject.ModelAttribute.default :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.default ``` ```` ````{py:property} fixed :canonical: arelle.ModelDtsObject.ModelAttribute.fixed :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.fixed ``` ```` ````{py:method} dereference() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelAttribute.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttribute.dereference ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelAttribute.name :type: str | None ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelAttribute.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelAttribute.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelAttribute.schemaNameQname ```` ````` `````{py:class} ModelAttributeGroup :canonical: arelle.ModelDtsObject.ModelAttributeGroup Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelAttributeGroup.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup.init ``` ```` ````{py:property} isQualifiedForm :canonical: arelle.ModelDtsObject.ModelAttributeGroup.isQualifiedForm :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup.isQualifiedForm ``` ```` ````{py:property} attributes :canonical: arelle.ModelDtsObject.ModelAttributeGroup.attributes :type: dict[arelle.ModelValue.QName, arelle.ModelDtsObject.ModelAttribute] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup.attributes ``` ```` ````{py:property} attributeWildcards :canonical: arelle.ModelDtsObject.ModelAttributeGroup.attributeWildcards :type: set[arelle.ModelObject.ModelObject] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup.attributeWildcards ``` ```` ````{py:method} dereference() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelAttributeGroup.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAttributeGroup.dereference ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelAttributeGroup.name :type: str | None ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelAttributeGroup.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelAttributeGroup.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelAttributeGroup.schemaNameQname ```` ````` `````{py:class} ModelType :canonical: arelle.ModelDtsObject.ModelType Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType ``` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelType.particlesList :type: arelle.ModelDtsObject.ParticlesList :value: > None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.particlesList ``` ```` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelType.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.init ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelType.name :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.name ``` ```` ````{py:property} isQualifiedForm :canonical: arelle.ModelDtsObject.ModelType.isQualifiedForm :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isQualifiedForm ``` ```` ````{py:property} qnameDerivedFrom :canonical: arelle.ModelDtsObject.ModelType.qnameDerivedFrom :type: arelle.ModelValue.QName | list[arelle.ModelValue.QName | None] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.qnameDerivedFrom ``` ```` ````{py:property} typeDerivedFrom :canonical: arelle.ModelDtsObject.ModelType.typeDerivedFrom :type: arelle.ModelDtsObject.ModelType | list[arelle.ModelDtsObject.ModelType | None] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.typeDerivedFrom ``` ```` ````{py:property} particles :canonical: arelle.ModelDtsObject.ModelType.particles :type: arelle.ModelDtsObject.ParticlesList ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.particles ``` ```` ````{py:property} baseXsdType :canonical: arelle.ModelDtsObject.ModelType.baseXsdType :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.baseXsdType ``` ```` ````{py:property} baseXbrliTypeQname :canonical: arelle.ModelDtsObject.ModelType.baseXbrliTypeQname :type: arelle.ModelValue.QName | list[arelle.ModelValue.QName] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.baseXbrliTypeQname ``` ```` ````{py:property} baseXbrliType :canonical: arelle.ModelDtsObject.ModelType.baseXbrliType :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.baseXbrliType ``` ```` ````{py:property} isTextBlock :canonical: arelle.ModelDtsObject.ModelType.isTextBlock :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isTextBlock ``` ```` ````{py:property} isOimTextFactType :canonical: arelle.ModelDtsObject.ModelType.isOimTextFactType :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isOimTextFactType ``` ```` ````{py:property} isWgnStringFactType :canonical: arelle.ModelDtsObject.ModelType.isWgnStringFactType :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isWgnStringFactType ``` ```` ````{py:property} isDomainItemType :canonical: arelle.ModelDtsObject.ModelType.isDomainItemType :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isDomainItemType ``` ```` ````{py:property} isMultiLanguage :canonical: arelle.ModelDtsObject.ModelType.isMultiLanguage :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isMultiLanguage ``` ```` ````{py:method} isDerivedFrom(typeqname: arelle.ModelValue.QName | collections.abc.Collection[arelle.ModelValue.QName]) -> bool :canonical: arelle.ModelDtsObject.ModelType.isDerivedFrom ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.isDerivedFrom ``` ```` ````{py:property} attributes :canonical: arelle.ModelDtsObject.ModelType.attributes :type: dict[arelle.ModelValue.QName, arelle.ModelDtsObject.ModelAttribute] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.attributes ``` ```` ````{py:property} attributeWildcards :canonical: arelle.ModelDtsObject.ModelType.attributeWildcards :type: list[typing.Any] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.attributeWildcards ``` ```` ````{py:property} requiredAttributeQnames :canonical: arelle.ModelDtsObject.ModelType.requiredAttributeQnames :type: set[arelle.ModelValue.QName] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.requiredAttributeQnames ``` ```` ````{py:property} defaultAttributeQnames :canonical: arelle.ModelDtsObject.ModelType.defaultAttributeQnames :type: set[arelle.ModelValue.QName] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.defaultAttributeQnames ``` ```` ````{py:property} elements :canonical: arelle.ModelDtsObject.ModelType.elements :type: set[arelle.ModelValue.QName] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.elements ``` ```` ````{py:property} facets :canonical: arelle.ModelDtsObject.ModelType.facets :type: dict[str, typing.Any] | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.facets ``` ```` ````{py:method} constrainingFacets(facetValues: dict[str, typing.Any] | None = None) -> dict[str, typing.Any] :canonical: arelle.ModelDtsObject.ModelType.constrainingFacets ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.constrainingFacets ``` ```` ````{py:method} fixedOrDefaultAttrValue(attrName: str) -> str | None :canonical: arelle.ModelDtsObject.ModelType.fixedOrDefaultAttrValue ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.fixedOrDefaultAttrValue ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelType.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.dereference ``` ```` ````{py:property} propertyView :canonical: arelle.ModelDtsObject.ModelType.propertyView :type: tuple[tuple[str, typing.Any], ...] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelType.propertyView ``` ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelType.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelType.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelType.schemaNameQname ```` ````` `````{py:class} ModelGroupDefinition :canonical: arelle.ModelDtsObject.ModelGroupDefinition Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm`, {py:obj}`arelle.ModelDtsObject.ModelParticle` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupDefinition ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelGroupDefinition.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupDefinition.init ``` ```` ````{py:method} dereference() -> arelle.ModelDtsObject.ModelGroupDefinition | None :canonical: arelle.ModelDtsObject.ModelGroupDefinition.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupDefinition.dereference ``` ```` ````{py:property} isQualifiedForm :canonical: arelle.ModelDtsObject.ModelGroupDefinition.isQualifiedForm :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupDefinition.isQualifiedForm ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelGroupDefinition.name :type: str | None ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelGroupDefinition.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelGroupDefinition.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelGroupDefinition.schemaNameQname ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelGroupDefinition.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelGroupDefinition.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelGroupDefinition.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelGroupDefinition.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelGroupDefinition.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelGroupDefinition.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelGroupDefinition.minOccursStr :type: str ```` ````` `````{py:class} ModelGroupCompositor :canonical: arelle.ModelDtsObject.ModelGroupCompositor Bases: {py:obj}`arelle.ModelObject.ModelObject`, {py:obj}`arelle.ModelDtsObject.ModelParticle` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupCompositor ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelGroupCompositor.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupCompositor.init ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelGroupCompositor.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelGroupCompositor.dereference ``` ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelGroupCompositor.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelGroupCompositor.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelGroupCompositor.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelGroupCompositor.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelGroupCompositor.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelGroupCompositor.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelGroupCompositor.minOccursStr :type: str ```` ````` `````{py:class} ModelAll :canonical: arelle.ModelDtsObject.ModelAll Bases: {py:obj}`arelle.ModelDtsObject.ModelGroupCompositor` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAll ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelAll.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAll.init ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelAll.dereference ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelAll.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelAll.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelAll.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelAll.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelAll.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelAll.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelAll.minOccursStr :type: str ```` ````` `````{py:class} ModelChoice :canonical: arelle.ModelDtsObject.ModelChoice Bases: {py:obj}`arelle.ModelDtsObject.ModelGroupCompositor` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelChoice ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelChoice.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelChoice.init ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelChoice.dereference ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelChoice.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelChoice.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelChoice.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelChoice.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelChoice.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelChoice.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelChoice.minOccursStr :type: str ```` ````` `````{py:class} ModelSequence :canonical: arelle.ModelDtsObject.ModelSequence Bases: {py:obj}`arelle.ModelDtsObject.ModelGroupCompositor` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelSequence ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelSequence.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelSequence.init ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelSequence.dereference ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelSequence.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelSequence.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelSequence.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelSequence.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelSequence.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelSequence.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelSequence.minOccursStr :type: str ```` ````` `````{py:class} ModelAny :canonical: arelle.ModelDtsObject.ModelAny Bases: {py:obj}`arelle.ModelDtsObject.AllowsNamespaceMixin`, {py:obj}`arelle.ModelObject.ModelObject`, {py:obj}`arelle.ModelDtsObject.ModelParticle` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAny ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelAny.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAny.init ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelAny.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAny.dereference ``` ```` ````{py:method} allowsNamespace(namespaceURI: str | None) -> bool :canonical: arelle.ModelDtsObject.ModelAny.allowsNamespace ```` ````{py:attribute} particlesList :canonical: arelle.ModelDtsObject.ModelAny.particlesList :type: list[typing_extensions.Self] :value: > None ```` ````{py:method} getparent() -> typing_extensions.Self | None :canonical: arelle.ModelDtsObject.ModelAny.getparent :abstractmethod: ```` ````{py:method} addToParticles() -> None :canonical: arelle.ModelDtsObject.ModelAny.addToParticles ```` ````{py:property} maxOccurs :canonical: arelle.ModelDtsObject.ModelAny.maxOccurs :type: int ```` ````{py:property} maxOccursStr :canonical: arelle.ModelDtsObject.ModelAny.maxOccursStr :type: str ```` ````{py:property} minOccurs :canonical: arelle.ModelDtsObject.ModelAny.minOccurs :type: int ```` ````{py:property} minOccursStr :canonical: arelle.ModelDtsObject.ModelAny.minOccursStr :type: str ```` ````` `````{py:class} ModelAnyAttribute :canonical: arelle.ModelDtsObject.ModelAnyAttribute Bases: {py:obj}`arelle.ModelDtsObject.AllowsNamespaceMixin`, {py:obj}`arelle.ModelObject.ModelObject` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAnyAttribute ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelAnyAttribute.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelAnyAttribute.init ``` ```` ````{py:method} allowsNamespace(namespaceURI: str | None) -> bool :canonical: arelle.ModelDtsObject.ModelAnyAttribute.allowsNamespace ```` ````` `````{py:class} ModelEnumeration :canonical: arelle.ModelDtsObject.ModelEnumeration Bases: {py:obj}`arelle.ModelDtsObject.ModelNamableTerm` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelEnumeration ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelEnumeration.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelEnumeration.init ``` ```` ````{py:property} value :canonical: arelle.ModelDtsObject.ModelEnumeration.value :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelEnumeration.value ``` ```` ````{py:property} name :canonical: arelle.ModelDtsObject.ModelEnumeration.name :type: str | None ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelEnumeration.qname :type: arelle.ModelValue.QName | None ```` ````{py:property} isGlobalDeclaration :canonical: arelle.ModelDtsObject.ModelEnumeration.isGlobalDeclaration :type: bool ```` ````{py:method} schemaNameQname(prefixedName: str | None, isQualifiedForm: bool = True, prefixException: Exception | type[Exception] | None = None) -> arelle.ModelValue.QName | None :canonical: arelle.ModelDtsObject.ModelEnumeration.schemaNameQname ```` ````` `````{py:class} ModelLink :canonical: arelle.ModelDtsObject.ModelLink Bases: {py:obj}`arelle.ModelObject.ModelObject`, {py:obj}`arelle.LinkRelationships.LinkRelationships` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLink ``` ````{py:attribute} labeledResources :canonical: arelle.ModelDtsObject.ModelLink.labeledResources :type: dict[str, list[arelle.ModelObject.ModelObject]] :value: > None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLink.labeledResources ``` ```` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelLink.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLink.init ``` ```` ````{py:method} initRelationships() -> None :canonical: arelle.ModelDtsObject.ModelLink.initRelationships ```` ````{py:property} relationships :canonical: arelle.ModelDtsObject.ModelLink.relationships :type: tuple[arelle.ModelDtsObject.ModelRelationship, ...] ```` ````{py:property} relationshipsByArcrole :canonical: arelle.ModelDtsObject.ModelLink.relationshipsByArcrole :type: dict[str, tuple[arelle.ModelDtsObject.ModelRelationship, ...]] ```` ````{py:property} relationshipsByArcroleArcqname :canonical: arelle.ModelDtsObject.ModelLink.relationshipsByArcroleArcqname :type: dict[str, dict[arelle.ModelValue.QName, tuple[arelle.ModelDtsObject.ModelRelationship, ...]]] ```` ````{py:property} dimensionRelationships :canonical: arelle.ModelDtsObject.ModelLink.dimensionRelationships :type: tuple[arelle.ModelDtsObject.ModelRelationship, ...] ```` ````{py:property} formulaRelationships :canonical: arelle.ModelDtsObject.ModelLink.formulaRelationships :type: tuple[arelle.ModelDtsObject.ModelRelationship, ...] ```` ````{py:property} tableRenderingRelationships :canonical: arelle.ModelDtsObject.ModelLink.tableRenderingRelationships :type: tuple[arelle.ModelDtsObject.ModelRelationship, ...] ```` ````` `````{py:class} ModelResource :canonical: arelle.ModelDtsObject.ModelResource Bases: {py:obj}`arelle.ModelObject.ModelObject`, {py:obj}`arelle.typing.ModelResourceBase` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelResource.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.init ``` ```` ````{py:property} role :canonical: arelle.ModelDtsObject.ModelResource.role :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.role ``` ```` ````{py:property} xlinkLabel :canonical: arelle.ModelDtsObject.ModelResource.xlinkLabel :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.xlinkLabel ``` ```` ````{py:property} xmlLang :canonical: arelle.ModelDtsObject.ModelResource.xmlLang :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.xmlLang ``` ```` ````{py:method} viewText(labelrole: str | None = None, lang: str | None = None) -> str :canonical: arelle.ModelDtsObject.ModelResource.viewText ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.viewText ``` ```` ````{py:method} roleRefPartSortKey() -> str :canonical: arelle.ModelDtsObject.ModelResource.roleRefPartSortKey ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.roleRefPartSortKey ``` ```` ````{py:method} dereference() -> typing_extensions.Self :canonical: arelle.ModelDtsObject.ModelResource.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelResource.dereference ``` ```` ````` `````{py:class} ModelLocator :canonical: arelle.ModelDtsObject.ModelLocator Bases: {py:obj}`arelle.ModelDtsObject.ModelResource` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLocator ``` ````{py:method} init(modelDocument: arelle.ModelDocument.ModelDocument) -> None :canonical: arelle.ModelDtsObject.ModelLocator.init ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLocator.init ``` ```` ````{py:method} dereference() -> arelle.ModelObject.ModelObject | None :canonical: arelle.ModelDtsObject.ModelLocator.dereference ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLocator.dereference ``` ```` ````{py:property} propertyView :canonical: arelle.ModelDtsObject.ModelLocator.propertyView :type: tuple[tuple[str, typing.Any], ...] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelLocator.propertyView ``` ```` ````{py:property} role :canonical: arelle.ModelDtsObject.ModelLocator.role :type: str | None ```` ````{py:property} xlinkLabel :canonical: arelle.ModelDtsObject.ModelLocator.xlinkLabel :type: str | None ```` ````{py:property} xmlLang :canonical: arelle.ModelDtsObject.ModelLocator.xmlLang :type: str | None ```` ````{py:method} viewText(labelrole: str | None = None, lang: str | None = None) -> str :canonical: arelle.ModelDtsObject.ModelLocator.viewText ```` ````{py:method} roleRefPartSortKey() -> str :canonical: arelle.ModelDtsObject.ModelLocator.roleRefPartSortKey ```` ````` `````{py:class} RelationStatus :canonical: arelle.ModelDtsObject.RelationStatus ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus ``` ````{py:attribute} Unknown :canonical: arelle.ModelDtsObject.RelationStatus.Unknown :value: > 0 ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus.Unknown ``` ```` ````{py:attribute} EFFECTIVE :canonical: arelle.ModelDtsObject.RelationStatus.EFFECTIVE :value: > 1 ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus.EFFECTIVE ``` ```` ````{py:attribute} OVERRIDDEN :canonical: arelle.ModelDtsObject.RelationStatus.OVERRIDDEN :value: > 2 ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus.OVERRIDDEN ``` ```` ````{py:attribute} PROHIBITED :canonical: arelle.ModelDtsObject.RelationStatus.PROHIBITED :value: > 3 ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus.PROHIBITED ``` ```` ````{py:attribute} INEFFECTIVE :canonical: arelle.ModelDtsObject.RelationStatus.INEFFECTIVE :value: > 4 ```{autodoc2-docstring} arelle.ModelDtsObject.RelationStatus.INEFFECTIVE ``` ```` ````` ````{py:data} arcCustAttrsExclusions :canonical: arelle.ModelDtsObject.arcCustAttrsExclusions :type: set[str] :value: > None ```{autodoc2-docstring} arelle.ModelDtsObject.arcCustAttrsExclusions ``` ```` ````{py:data} modelObjectAttrs :canonical: arelle.ModelDtsObject.modelObjectAttrs :type: frozenset[str] :value: > 'frozenset(...)' ```{autodoc2-docstring} arelle.ModelDtsObject.modelObjectAttrs ``` ```` ````{py:data} DECIMAL_1_0 :canonical: arelle.ModelDtsObject.DECIMAL_1_0 :value: > 'Decimal(...)' ```{autodoc2-docstring} arelle.ModelDtsObject.DECIMAL_1_0 ``` ```` `````{py:class} ModelRelationship(modelDocument: arelle.ModelDocument.ModelDocument, arcElement: arelle.ModelObject.ModelObject, fromModelObject: arelle.ModelObject.ModelObject | None, toModelObject: arelle.ModelObject.ModelObject | None, linkrole: str | None = None) :canonical: arelle.ModelDtsObject.ModelRelationship Bases: {py:obj}`arelle.ModelObject.ModelObject` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.__init__ ``` ````{py:attribute} ineffectivity :canonical: arelle.ModelDtsObject.ModelRelationship.ineffectivity :type: str :value: > None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.ineffectivity ``` ```` ````{py:method} clear() -> None :canonical: arelle.ModelDtsObject.ModelRelationship.clear ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.clear ``` ```` ````{py:method} get(attrname: str) -> str | None :canonical: arelle.ModelDtsObject.ModelRelationship.get ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.get ``` ```` ````{py:property} localName :canonical: arelle.ModelDtsObject.ModelRelationship.localName :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.localName ``` ```` ````{py:property} namespaceURI :canonical: arelle.ModelDtsObject.ModelRelationship.namespaceURI :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.namespaceURI ``` ```` ````{py:property} prefixedName :canonical: arelle.ModelDtsObject.ModelRelationship.prefixedName :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.prefixedName ``` ```` ````{py:property} sourceline :canonical: arelle.ModelDtsObject.ModelRelationship.sourceline :type: int | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.sourceline ``` ```` ````{py:property} tag :canonical: arelle.ModelDtsObject.ModelRelationship.tag :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.tag ``` ```` ````{py:property} elementQname :canonical: arelle.ModelDtsObject.ModelRelationship.elementQname :type: arelle.ModelValue.QName ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.elementQname ``` ```` ````{py:property} qname :canonical: arelle.ModelDtsObject.ModelRelationship.qname :type: arelle.ModelValue.QName ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.qname ``` ```` ````{py:method} itersiblings(**kwargs: typing.Any) -> collections.abc.Iterator[arelle.ModelObject.ModelObject] :canonical: arelle.ModelDtsObject.ModelRelationship.itersiblings ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.itersiblings ``` ```` ````{py:method} getparent() -> arelle.ModelObject.ModelObject | None :canonical: arelle.ModelDtsObject.ModelRelationship.getparent ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.getparent ``` ```` ````{py:property} fromLabel :canonical: arelle.ModelDtsObject.ModelRelationship.fromLabel :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.fromLabel ``` ```` ````{py:property} toLabel :canonical: arelle.ModelDtsObject.ModelRelationship.toLabel :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.toLabel ``` ```` ````{py:property} fromLocator :canonical: arelle.ModelDtsObject.ModelRelationship.fromLocator :type: arelle.ModelDtsObject.ModelLocator | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.fromLocator ``` ```` ````{py:property} toLocator :canonical: arelle.ModelDtsObject.ModelRelationship.toLocator :type: arelle.ModelDtsObject.ModelLocator | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.toLocator ``` ```` ````{py:method} locatorOf(dereferencedObject: arelle.ModelObject.ModelObject | None) -> arelle.ModelDtsObject.ModelLocator | None :canonical: arelle.ModelDtsObject.ModelRelationship.locatorOf ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.locatorOf ``` ```` ````{py:property} arcrole :canonical: arelle.ModelDtsObject.ModelRelationship.arcrole :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.arcrole ``` ```` ````{py:property} order :canonical: arelle.ModelDtsObject.ModelRelationship.order :type: float ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.order ``` ```` ````{py:property} orderDecimal :canonical: arelle.ModelDtsObject.ModelRelationship.orderDecimal :type: decimal.Decimal ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.orderDecimal ``` ```` ````{py:property} priority :canonical: arelle.ModelDtsObject.ModelRelationship.priority :type: int ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.priority ``` ```` ````{py:property} weight :canonical: arelle.ModelDtsObject.ModelRelationship.weight :type: float | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.weight ``` ```` ````{py:property} weightDecimal :canonical: arelle.ModelDtsObject.ModelRelationship.weightDecimal :type: decimal.Decimal | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.weightDecimal ``` ```` ````{py:property} use :canonical: arelle.ModelDtsObject.ModelRelationship.use :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.use ``` ```` ````{py:property} isProhibited :canonical: arelle.ModelDtsObject.ModelRelationship.isProhibited :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isProhibited ``` ```` ````{py:property} prohibitedUseSortKey :canonical: arelle.ModelDtsObject.ModelRelationship.prohibitedUseSortKey :type: int ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.prohibitedUseSortKey ``` ```` ````{py:property} preferredLabel :canonical: arelle.ModelDtsObject.ModelRelationship.preferredLabel :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.preferredLabel ``` ```` ````{py:property} variablename :canonical: arelle.ModelDtsObject.ModelRelationship.variablename :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.variablename ``` ```` ````{py:property} variableQname :canonical: arelle.ModelDtsObject.ModelRelationship.variableQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.variableQname ``` ```` ````{py:property} linkQname :canonical: arelle.ModelDtsObject.ModelRelationship.linkQname :type: arelle.ModelValue.QName | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.linkQname ``` ```` ````{py:property} contextElement :canonical: arelle.ModelDtsObject.ModelRelationship.contextElement :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.contextElement ``` ```` ````{py:property} targetRole :canonical: arelle.ModelDtsObject.ModelRelationship.targetRole :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.targetRole ``` ```` ````{py:property} consecutiveLinkrole :canonical: arelle.ModelDtsObject.ModelRelationship.consecutiveLinkrole :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.consecutiveLinkrole ``` ```` ````{py:property} isUsable :canonical: arelle.ModelDtsObject.ModelRelationship.isUsable :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isUsable ``` ```` ````{py:property} closed :canonical: arelle.ModelDtsObject.ModelRelationship.closed :type: str ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.closed ``` ```` ````{py:property} isClosed :canonical: arelle.ModelDtsObject.ModelRelationship.isClosed :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isClosed ``` ```` ````{py:property} usable :canonical: arelle.ModelDtsObject.ModelRelationship.usable :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.usable ``` ```` ````{py:property} isComplemented :canonical: arelle.ModelDtsObject.ModelRelationship.isComplemented :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isComplemented ``` ```` ````{py:property} isCovered :canonical: arelle.ModelDtsObject.ModelRelationship.isCovered :type: bool ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isCovered ``` ```` ````{py:property} axis :canonical: arelle.ModelDtsObject.ModelRelationship.axis :type: str | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.axis ``` ```` ````{py:property} equivalenceHash :canonical: arelle.ModelDtsObject.ModelRelationship.equivalenceHash :type: int ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.equivalenceHash ``` ```` ````{py:property} equivalenceKey :canonical: arelle.ModelDtsObject.ModelRelationship.equivalenceKey :type: tuple[typing.Any, ...] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.equivalenceKey ``` ```` ````{py:method} isIdenticalTo(otherModelRelationship: arelle.ModelDtsObject.ModelRelationship | None) -> bool :canonical: arelle.ModelDtsObject.ModelRelationship.isIdenticalTo ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.isIdenticalTo ``` ```` ````{py:method} priorityOver(otherModelRelationship: arelle.ModelDtsObject.ModelRelationship | None) -> bool :canonical: arelle.ModelDtsObject.ModelRelationship.priorityOver ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.priorityOver ``` ```` ````{py:property} propertyView :canonical: arelle.ModelDtsObject.ModelRelationship.propertyView :type: tuple[tuple[str, typing.Any], ...] ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.propertyView ``` ```` ````{py:property} viewConcept :canonical: arelle.ModelDtsObject.ModelRelationship.viewConcept :type: arelle.ModelDtsObject.ModelConcept | None ```{autodoc2-docstring} arelle.ModelDtsObject.ModelRelationship.viewConcept ``` ```` `````