# {py:mod}`iXBRLViewerPlugin`

```{py:module} iXBRLViewerPlugin
```

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

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

iXBRLViewerPlugin.ui
iXBRLViewerPlugin.plugin
iXBRLViewerPlugin.xhtmlserialize
iXBRLViewerPlugin.featureConfig
iXBRLViewerPlugin.constants
iXBRLViewerPlugin.iXBRLViewer
```

## Package Contents

### Classes

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

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

### Functions

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

* - {py:obj}`iXBRLViewerCommandLineOptionExtender <iXBRLViewerPlugin.iXBRLViewerCommandLineOptionExtender>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerCommandLineOptionExtender
    :summary:
    ```
* - {py:obj}`pluginData <iXBRLViewerPlugin.pluginData>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.pluginData
    :summary:
    ```
* - {py:obj}`resetPluginData <iXBRLViewerPlugin.resetPluginData>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.resetPluginData
    :summary:
    ```
* - {py:obj}`processModel <iXBRLViewerPlugin.processModel>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.processModel
    :summary:
    ```
* - {py:obj}`generateViewer <iXBRLViewerPlugin.generateViewer>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.generateViewer
    :summary:
    ```
* - {py:obj}`getFeaturesFromOptions <iXBRLViewerPlugin.getFeaturesFromOptions>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.getFeaturesFromOptions
    :summary:
    ```
* - {py:obj}`iXBRLViewerCommandLineXbrlRun <iXBRLViewerPlugin.iXBRLViewerCommandLineXbrlRun>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerCommandLineXbrlRun
    :summary:
    ```
* - {py:obj}`iXBRLViewerCommandLineFilingEnd <iXBRLViewerPlugin.iXBRLViewerCommandLineFilingEnd>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerCommandLineFilingEnd
    :summary:
    ```
* - {py:obj}`iXBRLViewerSaveCommand <iXBRLViewerPlugin.iXBRLViewerSaveCommand>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerSaveCommand
    :summary:
    ```
* - {py:obj}`iXBRLViewerSettingsCommand <iXBRLViewerPlugin.iXBRLViewerSettingsCommand>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerSettingsCommand
    :summary:
    ```
* - {py:obj}`iXBRLViewerToolsMenuExtender <iXBRLViewerPlugin.iXBRLViewerToolsMenuExtender>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerToolsMenuExtender
    :summary:
    ```
* - {py:obj}`toolsMenuExtender <iXBRLViewerPlugin.toolsMenuExtender>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.toolsMenuExtender
    :summary:
    ```
* - {py:obj}`commandLineOptionExtender <iXBRLViewerPlugin.commandLineOptionExtender>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.commandLineOptionExtender
    :summary:
    ```
* - {py:obj}`commandLineRun <iXBRLViewerPlugin.commandLineRun>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.commandLineRun
    :summary:
    ```
* - {py:obj}`commandLineFilingEnd <iXBRLViewerPlugin.commandLineFilingEnd>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.commandLineFilingEnd
    :summary:
    ```
* - {py:obj}`guiRun <iXBRLViewerPlugin.guiRun>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.guiRun
    :summary:
    ```
* - {py:obj}`load_plugin_url <iXBRLViewerPlugin.load_plugin_url>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.load_plugin_url
    :summary:
    ```
````

### Data

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

* - {py:obj}`PLUGIN_NAME <iXBRLViewerPlugin.PLUGIN_NAME>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.PLUGIN_NAME
    :summary:
    ```
* - {py:obj}`__pluginInfo__ <iXBRLViewerPlugin.__pluginInfo__>`
  - ```{autodoc2-docstring} iXBRLViewerPlugin.__pluginInfo__
    :summary:
    ```
````

### API

````{py:data} PLUGIN_NAME
:canonical: iXBRLViewerPlugin.PLUGIN_NAME
:value: >
   'ixbrl-viewer'

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

````

````{py:function} iXBRLViewerCommandLineOptionExtender(parser, *args, **kwargs)
:canonical: iXBRLViewerPlugin.iXBRLViewerCommandLineOptionExtender

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

````{py:function} pluginData(cntlr: arelle.Cntlr)
:canonical: iXBRLViewerPlugin.pluginData

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

````{py:function} resetPluginData(cntlr: arelle.Cntlr)
:canonical: iXBRLViewerPlugin.resetPluginData

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

````{py:function} processModel(cntlr: arelle.Cntlr, modelXbrl: ModelXbrl)
:canonical: iXBRLViewerPlugin.processModel

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

````{py:function} generateViewer(cntlr: arelle.Cntlr, saveViewerDest: io.BytesIO | str | None, viewerURL: str | None = None, showValidationMessages: bool = False, zipViewerOutput: bool = False, packageDownloadURL: str | None = None, copyScript: bool = True) -> None
:canonical: iXBRLViewerPlugin.generateViewer

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

````{py:function} getFeaturesFromOptions(options: argparse.Namespace | optparse.OptionParser) -> dict[str, typing.Any]
:canonical: iXBRLViewerPlugin.getFeaturesFromOptions

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

````{py:function} iXBRLViewerCommandLineXbrlRun(cntlr, options, modelXbrl, *args, **kwargs)
:canonical: iXBRLViewerPlugin.iXBRLViewerCommandLineXbrlRun

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

````{py:function} iXBRLViewerCommandLineFilingEnd(cntlr, options, *args, **kwargs)
:canonical: iXBRLViewerPlugin.iXBRLViewerCommandLineFilingEnd

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

````{py:function} iXBRLViewerSaveCommand(cntlr)
:canonical: iXBRLViewerPlugin.iXBRLViewerSaveCommand

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

````{py:function} iXBRLViewerSettingsCommand(cntlr)
:canonical: iXBRLViewerPlugin.iXBRLViewerSettingsCommand

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

````{py:function} iXBRLViewerToolsMenuExtender(cntlr, menu, *args, **kwargs)
:canonical: iXBRLViewerPlugin.iXBRLViewerToolsMenuExtender

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

````{py:function} toolsMenuExtender(cntlr, menu, *args, **kwargs)
:canonical: iXBRLViewerPlugin.toolsMenuExtender

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

````{py:function} commandLineOptionExtender(*args, **kwargs)
:canonical: iXBRLViewerPlugin.commandLineOptionExtender

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

````{py:function} commandLineRun(cntlr, options, modelXbrl, *args, **kwargs)
:canonical: iXBRLViewerPlugin.commandLineRun

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

````{py:function} commandLineFilingEnd(*args, **kwargs)
:canonical: iXBRLViewerPlugin.commandLineFilingEnd

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

`````{py:class} iXBRLViewerLocalViewer
:canonical: iXBRLViewerPlugin.iXBRLViewerLocalViewer

Bases: {py:obj}`arelle.LocalViewer.LocalViewer`

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

````{py:method} getLocalFile(file, relpath, request)
:canonical: iXBRLViewerPlugin.iXBRLViewerLocalViewer.getLocalFile

```{autodoc2-docstring} iXBRLViewerPlugin.iXBRLViewerLocalViewer.getLocalFile
```

````

`````

````{py:function} guiRun(cntlr, modelXbrl, attach, *args, **kwargs)
:canonical: iXBRLViewerPlugin.guiRun

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

````{py:function} load_plugin_url()
:canonical: iXBRLViewerPlugin.load_plugin_url

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

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

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

````