# {py:mod}`arelle.oim.csv.metadata.model`

```{py:module} arelle.oim.csv.metadata.model
```

```{autodoc2-docstring} arelle.oim.csv.metadata.model
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`XbrlCsvEffectiveMetadata <arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata
    :summary:
    ```
* - {py:obj}`XbrlCsvDocumentInfo <arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo
    :summary:
    ```
* - {py:obj}`XbrlCsvTableTemplate <arelle.oim.csv.metadata.model.XbrlCsvTableTemplate>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate
    :summary:
    ```
* - {py:obj}`XbrlCsvColumn <arelle.oim.csv.metadata.model.XbrlCsvColumn>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn
    :summary:
    ```
* - {py:obj}`XbrlCsvDimensions <arelle.oim.csv.metadata.model.XbrlCsvDimensions>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions
    :summary:
    ```
* - {py:obj}`XbrlCsvPropertyGroup <arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup
    :summary:
    ```
* - {py:obj}`XbrlCsvTable <arelle.oim.csv.metadata.model.XbrlCsvTable>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable
    :summary:
    ```
````

### Data

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

* - {py:obj}`LinkTargets <arelle.oim.csv.metadata.model.LinkTargets>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.LinkTargets
    :summary:
    ```
* - {py:obj}`LinkGroups <arelle.oim.csv.metadata.model.LinkGroups>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.LinkGroups
    :summary:
    ```
* - {py:obj}`Links <arelle.oim.csv.metadata.model.Links>`
  - ```{autodoc2-docstring} arelle.oim.csv.metadata.model.Links
    :summary:
    ```
````

### API

````{py:data} LinkTargets
:canonical: arelle.oim.csv.metadata.model.LinkTargets
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.LinkTargets
```

````

````{py:data} LinkGroups
:canonical: arelle.oim.csv.metadata.model.LinkGroups
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.LinkGroups
```

````

````{py:data} Links
:canonical: arelle.oim.csv.metadata.model.Links
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.Links
```

````

`````{py:class} XbrlCsvEffectiveMetadata
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata
```

````{py:attribute} document_info
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.document_info
:type: XbrlCsvDocumentInfo
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.document_info
```

````

````{py:attribute} table_templates
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.table_templates
:type: collections.abc.Mapping[str, XbrlCsvTableTemplate]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.table_templates
```

````

````{py:attribute} tables
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.tables
:type: collections.abc.Mapping[str, XbrlCsvTable]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.tables
```

````

````{py:attribute} parameters
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.parameters
:type: collections.abc.Mapping[str, str]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.parameters
```

````

````{py:attribute} parameter_url
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.parameter_url
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.parameter_url
```

````

````{py:attribute} dimensions
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.dimensions
:type: XbrlCsvDimensions | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.dimensions
```

````

````{py:attribute} decimals
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.decimals
:type: int | str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.decimals
```

````

````{py:attribute} links
:canonical: arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.links
:type: arelle.oim.csv.metadata.model.Links
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata.links
```

````

`````

`````{py:class} XbrlCsvDocumentInfo
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo
```

````{py:attribute} document_type
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.document_type
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.document_type
```

````

````{py:attribute} namespaces
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.namespaces
:type: collections.abc.Mapping[str, str]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.namespaces
```

````

````{py:attribute} link_types
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.link_types
:type: collections.abc.Mapping[str, str]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.link_types
```

````

````{py:attribute} link_groups
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.link_groups
:type: collections.abc.Mapping[str, str]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.link_groups
```

````

````{py:attribute} taxonomy
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.taxonomy
:type: tuple[str, ...]
:value: >
   ()

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.taxonomy
```

````

````{py:attribute} features
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.features
:type: collections.abc.Mapping[str, typing.Any]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.features
```

````

````{py:attribute} final
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.final
:type: collections.abc.Set[str]
:value: >
   'frozenset(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.final
```

````

````{py:attribute} base_url
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.base_url
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDocumentInfo.base_url
```

````

`````

`````{py:class} XbrlCsvTableTemplate
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTableTemplate

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate
```

````{py:attribute} row_id_column
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.row_id_column
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.row_id_column
```

````

````{py:attribute} columns
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.columns
:type: collections.abc.Mapping[str, XbrlCsvColumn]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.columns
```

````

````{py:attribute} decimals
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.decimals
:type: int | str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.decimals
```

````

````{py:attribute} dimensions
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.dimensions
:type: XbrlCsvDimensions | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTableTemplate.dimensions
```

````

`````

`````{py:class} XbrlCsvColumn
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn
```

````{py:attribute} comment
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn.comment
:type: bool
:value: >
   False

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn.comment
```

````

````{py:attribute} decimals
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn.decimals
:type: int | str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn.decimals
```

````

````{py:attribute} dimensions
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn.dimensions
:type: XbrlCsvDimensions | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn.dimensions
```

````

````{py:attribute} property_groups
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn.property_groups
:type: collections.abc.Mapping[str, XbrlCsvPropertyGroup]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn.property_groups
```

````

````{py:attribute} properties_from
:canonical: arelle.oim.csv.metadata.model.XbrlCsvColumn.properties_from
:type: tuple[str, ...] | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvColumn.properties_from
```

````

`````

`````{py:class} XbrlCsvDimensions
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions
```

````{py:attribute} concept
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.concept
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.concept
```

````

````{py:attribute} entity
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.entity
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.entity
```

````

````{py:attribute} period
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.period
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.period
```

````

````{py:attribute} unit
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.unit
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.unit
```

````

````{py:attribute} language
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.language
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.language
```

````

````{py:attribute} taxonomy_defined
:canonical: arelle.oim.csv.metadata.model.XbrlCsvDimensions.taxonomy_defined
:type: collections.abc.Mapping[str, str | None]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvDimensions.taxonomy_defined
```

````

`````

`````{py:class} XbrlCsvPropertyGroup
:canonical: arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup
```

````{py:attribute} decimals
:canonical: arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup.decimals
:type: int | str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup.decimals
```

````

````{py:attribute} dimensions
:canonical: arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup.dimensions
:type: arelle.oim.csv.metadata.model.XbrlCsvDimensions | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvPropertyGroup.dimensions
```

````

`````

`````{py:class} XbrlCsvTable
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTable

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable
```

````{py:attribute} url
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTable.url
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable.url
```

````

````{py:attribute} template
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTable.template
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable.template
```

````

````{py:attribute} optional
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTable.optional
:type: bool
:value: >
   False

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable.optional
```

````

````{py:attribute} parameters
:canonical: arelle.oim.csv.metadata.model.XbrlCsvTable.parameters
:type: collections.abc.Mapping[str, str]
:value: >
   'field(...)'

```{autodoc2-docstring} arelle.oim.csv.metadata.model.XbrlCsvTable.parameters
```

````

`````