# {py:mod}`arelle.ViewFileFormulae`

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

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

## Module Contents

### Classes

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

* - {py:obj}`ViewFormulae <arelle.ViewFileFormulae.ViewFormulae>`
  - ```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae
    :summary:
    ```
````

### Functions

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

* - {py:obj}`viewFormulae <arelle.ViewFileFormulae.viewFormulae>`
  - ```{autodoc2-docstring} arelle.ViewFileFormulae.viewFormulae
    :summary:
    ```
````

### API

````{py:function} viewFormulae(modelXbrl, outfile, header, lang=None)
:canonical: arelle.ViewFileFormulae.viewFormulae

```{autodoc2-docstring} arelle.ViewFileFormulae.viewFormulae
```
````

`````{py:class} ViewFormulae(modelXbrl, outfile, header, lang)
:canonical: arelle.ViewFileFormulae.ViewFormulae

Bases: {py:obj}`arelle.ViewFile.View`

```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae.__init__
```

````{py:method} view()
:canonical: arelle.ViewFileFormulae.ViewFormulae.view

```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae.view
```

````

````{py:method} treeDepth(fromObject, indent, visited)
:canonical: arelle.ViewFileFormulae.ViewFormulae.treeDepth

```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae.treeDepth
```

````

````{py:method} viewFormulaObjects(fromObject, fromRel, indent, visited)
:canonical: arelle.ViewFileFormulae.ViewFormulae.viewFormulaObjects

```{autodoc2-docstring} arelle.ViewFileFormulae.ViewFormulae.viewFormulaObjects
```

````

````{py:attribute} langDir
:canonical: arelle.ViewFileFormulae.ViewFormulae.langDir
:type: str
:value: >
   None

````

````{py:attribute} langAlign
:canonical: arelle.ViewFileFormulae.ViewFormulae.langAlign
:type: str
:value: >
   None

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} setAutoFilter(autoFilter: bool) -> None
:canonical: arelle.ViewFileFormulae.ViewFormulae.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.ViewFileFormulae.ViewFormulae.addRow

````

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

````

`````