# {py:mod}`arelle.ViewFile`

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

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

## Module Contents

### Classes

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

* - {py:obj}`View <arelle.ViewFile.View>`
  - ```{autodoc2-docstring} arelle.ViewFile.View
    :summary:
    ```
````

### Data

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

* - {py:obj}`NoneType <arelle.ViewFile.NoneType>`
  - ```{autodoc2-docstring} arelle.ViewFile.NoneType
    :summary:
    ```
* - {py:obj}`Workbook <arelle.ViewFile.Workbook>`
  - ```{autodoc2-docstring} arelle.ViewFile.Workbook
    :summary:
    ```
* - {py:obj}`cell <arelle.ViewFile.cell>`
  - ```{autodoc2-docstring} arelle.ViewFile.cell
    :summary:
    ```
* - {py:obj}`utils <arelle.ViewFile.utils>`
  - ```{autodoc2-docstring} arelle.ViewFile.utils
    :summary:
    ```
* - {py:obj}`Font <arelle.ViewFile.Font>`
  - ```{autodoc2-docstring} arelle.ViewFile.Font
    :summary:
    ```
* - {py:obj}`PatternFill <arelle.ViewFile.PatternFill>`
  - ```{autodoc2-docstring} arelle.ViewFile.PatternFill
    :summary:
    ```
* - {py:obj}`Border <arelle.ViewFile.Border>`
  - ```{autodoc2-docstring} arelle.ViewFile.Border
    :summary:
    ```
* - {py:obj}`Alignment <arelle.ViewFile.Alignment>`
  - ```{autodoc2-docstring} arelle.ViewFile.Alignment
    :summary:
    ```
* - {py:obj}`Color <arelle.ViewFile.Color>`
  - ```{autodoc2-docstring} arelle.ViewFile.Color
    :summary:
    ```
* - {py:obj}`fills <arelle.ViewFile.fills>`
  - ```{autodoc2-docstring} arelle.ViewFile.fills
    :summary:
    ```
* - {py:obj}`Side <arelle.ViewFile.Side>`
  - ```{autodoc2-docstring} arelle.ViewFile.Side
    :summary:
    ```
* - {py:obj}`NOOUT <arelle.ViewFile.NOOUT>`
  - ```{autodoc2-docstring} arelle.ViewFile.NOOUT
    :summary:
    ```
* - {py:obj}`CSV <arelle.ViewFile.CSV>`
  - ```{autodoc2-docstring} arelle.ViewFile.CSV
    :summary:
    ```
* - {py:obj}`XLSX <arelle.ViewFile.XLSX>`
  - ```{autodoc2-docstring} arelle.ViewFile.XLSX
    :summary:
    ```
* - {py:obj}`HTML <arelle.ViewFile.HTML>`
  - ```{autodoc2-docstring} arelle.ViewFile.HTML
    :summary:
    ```
* - {py:obj}`XML <arelle.ViewFile.XML>`
  - ```{autodoc2-docstring} arelle.ViewFile.XML
    :summary:
    ```
* - {py:obj}`JSON <arelle.ViewFile.JSON>`
  - ```{autodoc2-docstring} arelle.ViewFile.JSON
    :summary:
    ```
* - {py:obj}`TABULAR_VIEW_TYPES <arelle.ViewFile.TABULAR_VIEW_TYPES>`
  - ```{autodoc2-docstring} arelle.ViewFile.TABULAR_VIEW_TYPES
    :summary:
    ```
* - {py:obj}`TYPENAMES <arelle.ViewFile.TYPENAMES>`
  - ```{autodoc2-docstring} arelle.ViewFile.TYPENAMES
    :summary:
    ```
* - {py:obj}`nonNameCharPattern <arelle.ViewFile.nonNameCharPattern>`
  - ```{autodoc2-docstring} arelle.ViewFile.nonNameCharPattern
    :summary:
    ```
````

### API

````{py:data} NoneType
:canonical: arelle.ViewFile.NoneType
:value: >
   'type(...)'

```{autodoc2-docstring} arelle.ViewFile.NoneType
```

````

````{py:data} Workbook
:canonical: arelle.ViewFile.Workbook
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Workbook
```

````

````{py:data} cell
:canonical: arelle.ViewFile.cell
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.cell
```

````

````{py:data} utils
:canonical: arelle.ViewFile.utils
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.utils
```

````

````{py:data} Font
:canonical: arelle.ViewFile.Font
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Font
```

````

````{py:data} PatternFill
:canonical: arelle.ViewFile.PatternFill
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.PatternFill
```

````

````{py:data} Border
:canonical: arelle.ViewFile.Border
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Border
```

````

````{py:data} Alignment
:canonical: arelle.ViewFile.Alignment
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Alignment
```

````

````{py:data} Color
:canonical: arelle.ViewFile.Color
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Color
```

````

````{py:data} fills
:canonical: arelle.ViewFile.fills
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.fills
```

````

````{py:data} Side
:canonical: arelle.ViewFile.Side
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.Side
```

````

````{py:data} NOOUT
:canonical: arelle.ViewFile.NOOUT
:value: >
   0

```{autodoc2-docstring} arelle.ViewFile.NOOUT
```

````

````{py:data} CSV
:canonical: arelle.ViewFile.CSV
:value: >
   1

```{autodoc2-docstring} arelle.ViewFile.CSV
```

````

````{py:data} XLSX
:canonical: arelle.ViewFile.XLSX
:value: >
   2

```{autodoc2-docstring} arelle.ViewFile.XLSX
```

````

````{py:data} HTML
:canonical: arelle.ViewFile.HTML
:value: >
   3

```{autodoc2-docstring} arelle.ViewFile.HTML
```

````

````{py:data} XML
:canonical: arelle.ViewFile.XML
:value: >
   4

```{autodoc2-docstring} arelle.ViewFile.XML
```

````

````{py:data} JSON
:canonical: arelle.ViewFile.JSON
:value: >
   5

```{autodoc2-docstring} arelle.ViewFile.JSON
```

````

````{py:data} TABULAR_VIEW_TYPES
:canonical: arelle.ViewFile.TABULAR_VIEW_TYPES
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.TABULAR_VIEW_TYPES
```

````

````{py:data} TYPENAMES
:canonical: arelle.ViewFile.TYPENAMES
:value: >
   ['NOOUT', 'CSV', 'XLSX', 'HTML', 'XML', 'JSON']

```{autodoc2-docstring} arelle.ViewFile.TYPENAMES
```

````

````{py:data} nonNameCharPattern
:canonical: arelle.ViewFile.nonNameCharPattern
:value: >
   'compile(...)'

```{autodoc2-docstring} arelle.ViewFile.nonNameCharPattern
```

````

`````{py:class} View(modelXbrl: arelle.ModelXbrl.ModelXbrl | None, outfile: str | arelle.FileSource.FileNamedStringIO | None, rootElementName: str, lang: str | None = None, style: str = 'table', cssExtras: str = '')
:canonical: arelle.ViewFile.View

```{autodoc2-docstring} arelle.ViewFile.View
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.ViewFile.View.__init__
```

````{py:attribute} langDir
:canonical: arelle.ViewFile.View.langDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.langDir
```

````

````{py:attribute} langAlign
:canonical: arelle.ViewFile.View.langAlign
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.langAlign
```

````

````{py:attribute} xmlRowElementName
:canonical: arelle.ViewFile.View.xmlRowElementName
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.xmlRowElementName
```

````

````{py:attribute} columnEltNames
:canonical: arelle.ViewFile.View.columnEltNames
:type: list[str]
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.columnEltNames
```

````

````{py:attribute} csvFile
:canonical: arelle.ViewFile.View.csvFile
:type: arelle.FileSource.FileNamedStringIO | io.TextIOWrapper
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.csvFile
```

````

````{py:attribute} xmlDoc
:canonical: arelle.ViewFile.View.xmlDoc
:type: lxml.etree._ElementTree | None
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.xmlDoc
```

````

````{py:attribute} tblElt
:canonical: arelle.ViewFile.View.tblElt
:type: lxml.etree._Element | None
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.tblElt
```

````

````{py:attribute} xlsxWs
:canonical: arelle.ViewFile.View.xlsxWs
:type: openpyxl.worksheet._write_only.WriteOnlyWorksheet | openpyxl.worksheet.worksheet.Worksheet
:value: >
   None

```{autodoc2-docstring} arelle.ViewFile.View.xlsxWs
```

````

````{py:method} setColWidths(colWidths: typing.Iterable[float]) -> None
:canonical: arelle.ViewFile.View.setColWidths

```{autodoc2-docstring} arelle.ViewFile.View.setColWidths
```

````

````{py:method} setColWrapText(colColWrapText: list[bool]) -> None
:canonical: arelle.ViewFile.View.setColWrapText

```{autodoc2-docstring} arelle.ViewFile.View.setColWrapText
```

````

````{py:method} setAutoFilter(autoFilter: bool) -> None
:canonical: arelle.ViewFile.View.setAutoFilter

```{autodoc2-docstring} arelle.ViewFile.View.setAutoFilter
```

````

````{py:method} addRow(cols: typing.Sequence[str | int | float | decimal.Decimal | None], asHeader: bool = False, treeIndent: int = 0, colSpan: int = 1, xmlRowElementName: str | None = None, xmlRowEltAttr: dict[str, typing.Any] | None = None, xmlRowText: str | None = None, xmlCol0skipElt: bool = False, xmlColElementNames: list[str] | None = None, lastColSpan: int | None = None, arcRole: str | None = None) -> None
:canonical: arelle.ViewFile.View.addRow

```{autodoc2-docstring} arelle.ViewFile.View.addRow
```

````

````{py:method} close(noWrite: bool = False) -> None
:canonical: arelle.ViewFile.View.close

```{autodoc2-docstring} arelle.ViewFile.View.close
```

````

`````