# {py:mod}`arelle.PrototypeDtsObject`

```{py:module} arelle.PrototypeDtsObject
```

```{autodoc2-docstring} arelle.PrototypeDtsObject
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`PrototypeObject <arelle.PrototypeDtsObject.PrototypeObject>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject
    :summary:
    ```
* - {py:obj}`LinkPrototype <arelle.PrototypeDtsObject.LinkPrototype>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.LinkPrototype
    :summary:
    ```
* - {py:obj}`LocPrototype <arelle.PrototypeDtsObject.LocPrototype>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype
    :summary:
    ```
* - {py:obj}`ArcPrototype <arelle.PrototypeDtsObject.ArcPrototype>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype
    :summary:
    ```
* - {py:obj}`DocumentPrototype <arelle.PrototypeDtsObject.DocumentPrototype>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.DocumentPrototype
    :summary:
    ```
* - {py:obj}`PrototypeElementTree <arelle.PrototypeDtsObject.PrototypeElementTree>`
  - ```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree
    :summary:
    ```
````

### API

`````{py:class} PrototypeObject(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, sourceElement: arelle.ModelObject.ModelObject | None = None)
:canonical: arelle.PrototypeDtsObject.PrototypeObject

Bases: {py:obj}`arelle.typing.PrototypeObjectBase`

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.__init__
```

````{py:property} sourceline
:canonical: arelle.PrototypeDtsObject.PrototypeObject.sourceline
:type: int | None

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.sourceline
```

````

````{py:method} get(key: str, default: str | None = None) -> str | None
:canonical: arelle.PrototypeDtsObject.PrototypeObject.get

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.get
```

````

````{py:method} itersiblings(**kwargs: typing.Any) -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.PrototypeObject.itersiblings

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.itersiblings
```

````

````{py:method} getparent() -> arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None
:canonical: arelle.PrototypeDtsObject.PrototypeObject.getparent

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.getparent
```

````

````{py:method} iterchildren() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.PrototypeObject.iterchildren

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.iterchildren
```

````

````{py:method} iterdescendants() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.PrototypeObject.iterdescendants

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeObject.iterdescendants
```

````

`````

`````{py:class} LinkPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, qname: arelle.ModelValue.QName, role: str | None, sourceElement: arelle.ModelObject.ModelObject | None = None)
:canonical: arelle.PrototypeDtsObject.LinkPrototype

Bases: {py:obj}`arelle.PrototypeDtsObject.PrototypeObject`, {py:obj}`arelle.LinkRelationships.LinkRelationships`

```{autodoc2-docstring} arelle.PrototypeDtsObject.LinkPrototype
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.LinkPrototype.__init__
```

````{py:method} clear() -> None
:canonical: arelle.PrototypeDtsObject.LinkPrototype.clear

```{autodoc2-docstring} arelle.PrototypeDtsObject.LinkPrototype.clear
```

````

````{py:method} getparent() -> arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None
:canonical: arelle.PrototypeDtsObject.LinkPrototype.getparent

````

````{py:method} iterchildren() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LinkPrototype.iterchildren

```{autodoc2-docstring} arelle.PrototypeDtsObject.LinkPrototype.iterchildren
```

````

````{py:property} sourceline
:canonical: arelle.PrototypeDtsObject.LinkPrototype.sourceline
:type: int | None

````

````{py:method} get(key: str, default: str | None = None) -> str | None
:canonical: arelle.PrototypeDtsObject.LinkPrototype.get

````

````{py:method} itersiblings(**kwargs: typing.Any) -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LinkPrototype.itersiblings

````

````{py:method} iterdescendants() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LinkPrototype.iterdescendants

````

`````

`````{py:class} LocPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, label: str, locObject: str | arelle.ModelObject.ModelObject | arelle.ModelDtsObject.ModelResource, role: str | None = None, sourceElement: arelle.ModelObject.ModelObject | None = None)
:canonical: arelle.PrototypeDtsObject.LocPrototype

Bases: {py:obj}`arelle.PrototypeDtsObject.PrototypeObject`, {py:obj}`arelle.typing.LocPrototypeBase`

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype.__init__
```

````{py:method} clear() -> None
:canonical: arelle.PrototypeDtsObject.LocPrototype.clear

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype.clear
```

````

````{py:property} xlinkLabel
:canonical: arelle.PrototypeDtsObject.LocPrototype.xlinkLabel
:type: str | None

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype.xlinkLabel
```

````

````{py:method} dereference() -> typing.Any
:canonical: arelle.PrototypeDtsObject.LocPrototype.dereference

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype.dereference
```

````

````{py:method} getparent() -> arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None
:canonical: arelle.PrototypeDtsObject.LocPrototype.getparent

````

````{py:method} get(key: str, default: str | None = None) -> str | None
:canonical: arelle.PrototypeDtsObject.LocPrototype.get

```{autodoc2-docstring} arelle.PrototypeDtsObject.LocPrototype.get
```

````

````{py:property} sourceline
:canonical: arelle.PrototypeDtsObject.LocPrototype.sourceline
:type: int | None

````

````{py:method} itersiblings(**kwargs: typing.Any) -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LocPrototype.itersiblings

````

````{py:method} iterchildren() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LocPrototype.iterchildren

````

````{py:method} iterdescendants() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.LocPrototype.iterdescendants

````

`````

`````{py:class} ArcPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, qname: arelle.ModelValue.QName, fromLabel: str, toLabel: str, linkrole: str, arcrole: str, order: str = '1', sourceElement: arelle.ModelObject.ModelObject | None = None)
:canonical: arelle.PrototypeDtsObject.ArcPrototype

Bases: {py:obj}`arelle.PrototypeDtsObject.PrototypeObject`

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.__init__
```

````{py:property} orderDecimal
:canonical: arelle.PrototypeDtsObject.ArcPrototype.orderDecimal
:type: decimal.Decimal

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.orderDecimal
```

````

````{py:method} clear() -> None
:canonical: arelle.PrototypeDtsObject.ArcPrototype.clear

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.clear
```

````

````{py:property} arcElement
:canonical: arelle.PrototypeDtsObject.ArcPrototype.arcElement
:type: arelle.ModelObject.ModelObject | None

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.arcElement
```

````

````{py:method} getparent() -> arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None
:canonical: arelle.PrototypeDtsObject.ArcPrototype.getparent

````

````{py:method} get(key: str, default: str | None = None) -> str | None
:canonical: arelle.PrototypeDtsObject.ArcPrototype.get

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.get
```

````

````{py:method} items() -> typing.ItemsView[str, str]
:canonical: arelle.PrototypeDtsObject.ArcPrototype.items

```{autodoc2-docstring} arelle.PrototypeDtsObject.ArcPrototype.items
```

````

````{py:property} sourceline
:canonical: arelle.PrototypeDtsObject.ArcPrototype.sourceline
:type: int | None

````

````{py:method} itersiblings(**kwargs: typing.Any) -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.ArcPrototype.itersiblings

````

````{py:method} iterchildren() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.ArcPrototype.iterchildren

````

````{py:method} iterdescendants() -> collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]
:canonical: arelle.PrototypeDtsObject.ArcPrototype.iterdescendants

````

`````

`````{py:class} DocumentPrototype(modelXbrl: arelle.ModelXbrl.ModelXbrl, uri: str, base: str | None = None, referringElement: arelle.ModelObject.ModelObject | None = None, isEntry: bool = False, isDiscovered: bool = False, isIncluded: bool | None = None, namespace: str | None = None, reloadCache: bool = False, **kwargs: typing.Any)
:canonical: arelle.PrototypeDtsObject.DocumentPrototype

```{autodoc2-docstring} arelle.PrototypeDtsObject.DocumentPrototype
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.DocumentPrototype.__init__
```

````{py:method} clear() -> None
:canonical: arelle.PrototypeDtsObject.DocumentPrototype.clear

```{autodoc2-docstring} arelle.PrototypeDtsObject.DocumentPrototype.clear
```

````

`````

`````{py:class} PrototypeElementTree(rootElement: arelle.ModelObject.ModelObject)
:canonical: arelle.PrototypeDtsObject.PrototypeElementTree

Bases: {py:obj}`arelle.typing.PrototypeElementTreeBase`

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree.__init__
```

````{py:method} getroot() -> arelle.ModelObject.ModelObject
:canonical: arelle.PrototypeDtsObject.PrototypeElementTree.getroot

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree.getroot
```

````

````{py:method} iter() -> collections.abc.Iterator[arelle.ModelObject.ModelObject]
:canonical: arelle.PrototypeDtsObject.PrototypeElementTree.iter

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree.iter
```

````

````{py:method} ixIter(childOnly: bool = False) -> collections.abc.Iterator[arelle.ModelObject.ModelObject]
:canonical: arelle.PrototypeDtsObject.PrototypeElementTree.ixIter

```{autodoc2-docstring} arelle.PrototypeDtsObject.PrototypeElementTree.ixIter
```

````

`````