# {py:mod}`arelle.LinkRelationships`

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

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

## Module Contents

### Classes

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

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

### Data

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

* - {py:obj}`ModelRelationship <arelle.LinkRelationships.ModelRelationship>`
  - ```{autodoc2-docstring} arelle.LinkRelationships.ModelRelationship
    :summary:
    ```
````

### API

````{py:data} ModelRelationship
:canonical: arelle.LinkRelationships.ModelRelationship
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.ModelRelationship
```

````

`````{py:class} LinkRelationships
:canonical: arelle.LinkRelationships.LinkRelationships

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships
```

````{py:attribute} _relationships
:canonical: arelle.LinkRelationships.LinkRelationships._relationships
:type: tuple[arelle.LinkRelationships.ModelRelationship, ...] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._relationships
```

````

````{py:attribute} _relationshipsByArcrole
:canonical: arelle.LinkRelationships.LinkRelationships._relationshipsByArcrole
:type: dict[str, tuple[arelle.LinkRelationships.ModelRelationship, ...]] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._relationshipsByArcrole
```

````

````{py:attribute} _relationshipsByArcroleArcqname
:canonical: arelle.LinkRelationships.LinkRelationships._relationshipsByArcroleArcqname
:type: dict[str, dict[arelle.ModelValue.QName, tuple[arelle.LinkRelationships.ModelRelationship, ...]]] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._relationshipsByArcroleArcqname
```

````

````{py:attribute} _dimensionRelationships
:canonical: arelle.LinkRelationships.LinkRelationships._dimensionRelationships
:type: tuple[arelle.LinkRelationships.ModelRelationship, ...] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._dimensionRelationships
```

````

````{py:attribute} _formulaRelationships
:canonical: arelle.LinkRelationships.LinkRelationships._formulaRelationships
:type: tuple[arelle.LinkRelationships.ModelRelationship, ...] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._formulaRelationships
```

````

````{py:attribute} _tableRenderingRelationships
:canonical: arelle.LinkRelationships.LinkRelationships._tableRenderingRelationships
:type: tuple[arelle.LinkRelationships.ModelRelationship, ...] | None
:value: >
   None

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._tableRenderingRelationships
```

````

````{py:method} initRelationships() -> None
:canonical: arelle.LinkRelationships.LinkRelationships.initRelationships

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.initRelationships
```

````

````{py:property} relationships
:canonical: arelle.LinkRelationships.LinkRelationships.relationships
:type: tuple[arelle.ModelDtsObject.ModelRelationship, ...]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.relationships
```

````

````{py:property} relationshipsByArcrole
:canonical: arelle.LinkRelationships.LinkRelationships.relationshipsByArcrole
:type: dict[str, tuple[arelle.ModelDtsObject.ModelRelationship, ...]]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.relationshipsByArcrole
```

````

````{py:property} relationshipsByArcroleArcqname
:canonical: arelle.LinkRelationships.LinkRelationships.relationshipsByArcroleArcqname
:type: dict[str, dict[arelle.ModelValue.QName, tuple[arelle.ModelDtsObject.ModelRelationship, ...]]]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.relationshipsByArcroleArcqname
```

````

````{py:property} dimensionRelationships
:canonical: arelle.LinkRelationships.LinkRelationships.dimensionRelationships
:type: tuple[arelle.ModelDtsObject.ModelRelationship, ...]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.dimensionRelationships
```

````

````{py:property} formulaRelationships
:canonical: arelle.LinkRelationships.LinkRelationships.formulaRelationships
:type: tuple[arelle.ModelDtsObject.ModelRelationship, ...]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.formulaRelationships
```

````

````{py:property} tableRenderingRelationships
:canonical: arelle.LinkRelationships.LinkRelationships.tableRenderingRelationships
:type: tuple[arelle.ModelDtsObject.ModelRelationship, ...]

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships.tableRenderingRelationships
```

````

````{py:method} _relationshipsForArcrolePredicate(predicate: typing.Callable[[str], bool]) -> tuple[arelle.ModelDtsObject.ModelRelationship, ...]
:canonical: arelle.LinkRelationships.LinkRelationships._relationshipsForArcrolePredicate

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._relationshipsForArcrolePredicate
```

````

````{py:method} _collectRelationships() -> None
:canonical: arelle.LinkRelationships.LinkRelationships._collectRelationships

```{autodoc2-docstring} arelle.LinkRelationships.LinkRelationships._collectRelationships
```

````

`````