# {py:mod}`iXBRLViewerPlugin.iXBRLViewer`

```{py:module} iXBRLViewerPlugin.iXBRLViewer
```

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`NamespaceMap <iXBRLViewerPlugin.iXBRLViewer.NamespaceMap>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.NamespaceMap
    :summary:
    ```
* - {py:obj}`IXBRLViewerBuilder <iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder
    :summary:
    ```
* - {py:obj}`iXBRLViewerFile <iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile
    :summary:
    ```
* - {py:obj}`iXBRLViewer <iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer
    :summary:
    ```
````

### Functions

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

* - {py:obj}`isInlineDoc <iXBRLViewerPlugin.iXBRLViewer.isInlineDoc>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.isInlineDoc
    :summary:
    ```
````

### Data

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

* - {py:obj}`REPORT_TYPE_EXTENSIONS <iXBRLViewerPlugin.iXBRLViewer.REPORT_TYPE_EXTENSIONS>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.REPORT_TYPE_EXTENSIONS
    :summary:
    ```
* - {py:obj}`UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE <iXBRLViewerPlugin.iXBRLViewer.UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE
    :summary:
    ```
* - {py:obj}`LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE <iXBRLViewerPlugin.iXBRLViewer.LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE
    :summary:
    ```
* - {py:obj}`WIDER_NARROWER_ARCROLE <iXBRLViewerPlugin.iXBRLViewer.WIDER_NARROWER_ARCROLE>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.WIDER_NARROWER_ARCROLE
    :summary:
    ```
````

### API

````{py:data} REPORT_TYPE_EXTENSIONS
:canonical: iXBRLViewerPlugin.iXBRLViewer.REPORT_TYPE_EXTENSIONS
:value: >
   ('.xbrl', '.xhtml', '.html', '.htm', '.json')

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.REPORT_TYPE_EXTENSIONS
```

````

````{py:data} UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE
:canonical: iXBRLViewerPlugin.iXBRLViewer.UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE
:value: >
   'unrecognizedLinkbase'

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.UNRECOGNIZED_LINKBASE_LOCAL_DOCUMENTS_TYPE
```

````

````{py:data} LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE
:canonical: iXBRLViewerPlugin.iXBRLViewer.LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE
:value: >
   None

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.LINK_QNAME_TO_LOCAL_DOCUMENTS_LINKBASE_TYPE
```

````

````{py:data} WIDER_NARROWER_ARCROLE
:canonical: iXBRLViewerPlugin.iXBRLViewer.WIDER_NARROWER_ARCROLE
:value: >
   'http://www.esma.europa.eu/xbrl/esef/arcrole/wider-narrower'

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.WIDER_NARROWER_ARCROLE
```

````

`````{py:class} NamespaceMap()
:canonical: iXBRLViewerPlugin.iXBRLViewer.NamespaceMap

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.NamespaceMap
```

```{rubric} Initialization
```

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.NamespaceMap.__init__
```

````{py:method} getPrefix(ns: str, preferredPrefix: str | None = None) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.NamespaceMap.getPrefix

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.NamespaceMap.getPrefix
```

````

````{py:method} qname(qname: arelle.ModelValue.QName) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.NamespaceMap.qname

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.NamespaceMap.qname
```

````

`````

```{py:exception} IXBRLViewerBuilderError()
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilderError

Bases: {py:obj}`Exception`

```

````{py:function} isInlineDoc(doc: arelle.ModelDocument.ModelDocument | None) -> bool
:canonical: iXBRLViewerPlugin.iXBRLViewer.isInlineDoc

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.isInlineDoc
```
````

`````{py:class} IXBRLViewerBuilder(cntlr: arelle.Cntlr.Cntlr, basenameSuffix: str = '', useStubViewer: bool = False, features: dict[str, typing.Any] | None = None)
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder
```

```{rubric} Initialization
```

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.__init__
```

````{py:method} outputFilename(filename: str) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.outputFilename

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.outputFilename
```

````

````{py:method} lineWrap(s: str, n: int = 80) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.lineWrap

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.lineWrap
```

````

````{py:method} dateFormat(d: str) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.dateFormat

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.dateFormat
```

````

````{py:method} escapeJSONForScriptTag(s: str) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.escapeJSONForScriptTag

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.escapeJSONForScriptTag
```

````

````{py:method} addRoleDefinition(report: arelle.ModelXbrl.ModelXbrl, elr: str) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addRoleDefinition

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addRoleDefinition
```

````

````{py:method} addConcept(report: arelle.ModelXbrl.ModelXbrl, concept: arelle.ModelDtsObject.ModelConcept | None, dimensionType: str | None = None) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addConcept

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addConcept
```

````

````{py:method} treeWalk(rels: arelle.ModelRelationshipSet.ModelRelationshipSet, item: typing.Any, indent: int = 0) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.treeWalk

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.treeWalk
```

````

````{py:method} getRelationships(report: arelle.ModelXbrl.ModelXbrl) -> dict[str, dict[str, dict[str, list[dict[str, str]]]]]
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.getRelationships

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.getRelationships
```

````

````{py:method} validationErrors() -> list[dict[str, str]]
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.validationErrors

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.validationErrors
```

````

````{py:method} addFact(report: arelle.ModelXbrl.ModelXbrl, f: arelle.ModelInstanceObject.ModelInlineFact) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addFact

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addFact
```

````

````{py:method} oimUnitString(unit: arelle.ModelInstanceObject.ModelUnit) -> str
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.oimUnitString

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.oimUnitString
```

````

````{py:method} addViewerData(viewerFile: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile, scriptUrl: str) -> bool
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addViewerData

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addViewerData
```

````

````{py:method} getStubDocument() -> lxml.etree._ElementTree[lxml.etree._Element]
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.getStubDocument

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.getStubDocument
```

````

````{py:method} newTargetReport(target: str | None) -> dict[str, typing.Any]
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.newTargetReport

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.newTargetReport
```

````

````{py:method} addSourceReport() -> dict[str, list[typing.Any]]
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addSourceReport

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.addSourceReport
```

````

````{py:method} processModel(report: arelle.ModelXbrl.ModelXbrl) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.processModel

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.processModel
```

````

````{py:method} createViewer(scriptUrl: str = DEFAULT_JS_FILENAME, showValidations: bool = True, packageDownloadURL: str | None = None) -> iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer | None
:canonical: iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.createViewer

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.IXBRLViewerBuilder.createViewer
```

````

`````

````{py:class} iXBRLViewerFile(filename: str, xmlDocument: lxml.etree._ElementTree[lxml.etree._Element])
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile
```

```{rubric} Initialization
```

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile.__init__
```

````

`````{py:class} iXBRLViewer(cntlr: arelle.Cntlr.Cntlr)
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer
```

```{rubric} Initialization
```

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.__init__
```

````{py:method} addReportAssets(assets: list[str]) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addReportAssets

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addReportAssets
```

````

````{py:method} addFile(ivf: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addFile

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addFile
```

````

````{py:property} files
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.files
:type: list[iXBRLViewerPlugin.iXBRLViewer.iXBRLViewerFile]

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.files
```

````

````{py:method} addFilingDoc(filingDocuments: str) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addFilingDoc

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.addFilingDoc
```

````

````{py:method} save(destination: io.BytesIO | str, zipOutput: bool = False, copyScriptPath: pathlib.Path | None = None) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.save

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer.save
```

````

````{py:method} _copyScript(destDirectory: pathlib.Path, scriptPath: pathlib.Path) -> None
:canonical: iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer._copyScript

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewer.iXBRLViewer._copyScript
```

````

`````