# {py:mod}`pyirk.visualization`

```{py:module} pyirk.visualization
```

```{autodoc2-docstring} pyirk.visualization
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`AbstractGraphObject <pyirk.visualization.AbstractGraphObject>`
  - ```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject
    :summary:
    ```
* - {py:obj}`EntityNode <pyirk.visualization.EntityNode>`
  - ```{autodoc2-docstring} pyirk.visualization.EntityNode
    :summary:
    ```
* - {py:obj}`LiteralStrNode <pyirk.visualization.LiteralStrNode>`
  -
* - {py:obj}`Edge <pyirk.visualization.Edge>`
  - ```{autodoc2-docstring} pyirk.visualization.Edge
    :summary:
    ```
* - {py:obj}`CustomizedDiGraph <pyirk.visualization.CustomizedDiGraph>`
  -
* - {py:obj}`VisualizationManager <pyirk.visualization.VisualizationManager>`
  - ```{autodoc2-docstring} pyirk.visualization.VisualizationManager
    :summary:
    ```
````

### Functions

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

* - {py:obj}`key_generator <pyirk.visualization.key_generator>`
  - ```{autodoc2-docstring} pyirk.visualization.key_generator
    :summary:
    ```
* - {py:obj}`create_node <pyirk.visualization.create_node>`
  - ```{autodoc2-docstring} pyirk.visualization.create_node
    :summary:
    ```
* - {py:obj}`create_key_with_length <pyirk.visualization.create_key_with_length>`
  - ```{autodoc2-docstring} pyirk.visualization.create_key_with_length
    :summary:
    ```
* - {py:obj}`create_label_segments <pyirk.visualization.create_label_segments>`
  - ```{autodoc2-docstring} pyirk.visualization.create_label_segments
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <pyirk.visualization.__all__>`
  - ```{autodoc2-docstring} pyirk.visualization.__all__
    :summary:
    ```
* - {py:obj}`REPLACEMENTS <pyirk.visualization.REPLACEMENTS>`
  - ```{autodoc2-docstring} pyirk.visualization.REPLACEMENTS
    :summary:
    ```
* - {py:obj}`FONTSIZE <pyirk.visualization.FONTSIZE>`
  - ```{autodoc2-docstring} pyirk.visualization.FONTSIZE
    :summary:
    ```
* - {py:obj}`NEWLINE_REPLACEMENTS <pyirk.visualization.NEWLINE_REPLACEMENTS>`
  - ```{autodoc2-docstring} pyirk.visualization.NEWLINE_REPLACEMENTS
    :summary:
    ```
* - {py:obj}`mpl_colors <pyirk.visualization.mpl_colors>`
  - ```{autodoc2-docstring} pyirk.visualization.mpl_colors
    :summary:
    ```
* - {py:obj}`label_segment_key_gen <pyirk.visualization.label_segment_key_gen>`
  - ```{autodoc2-docstring} pyirk.visualization.label_segment_key_gen
    :summary:
    ```
* - {py:obj}`literal_node_key_gen <pyirk.visualization.literal_node_key_gen>`
  - ```{autodoc2-docstring} pyirk.visualization.literal_node_key_gen
    :summary:
    ```
* - {py:obj}`relation_key_gen <pyirk.visualization.relation_key_gen>`
  - ```{autodoc2-docstring} pyirk.visualization.relation_key_gen
    :summary:
    ```
* - {py:obj}`vm <pyirk.visualization.vm>`
  - ```{autodoc2-docstring} pyirk.visualization.vm
    :summary:
    ```
* - {py:obj}`visualize_entity <pyirk.visualization.visualize_entity>`
  - ```{autodoc2-docstring} pyirk.visualization.visualize_entity
    :summary:
    ```
* - {py:obj}`visualize_all_entities <pyirk.visualization.visualize_all_entities>`
  - ```{autodoc2-docstring} pyirk.visualization.visualize_all_entities
    :summary:
    ```
* - {py:obj}`create_nx_graph_from_entity <pyirk.visualization.create_nx_graph_from_entity>`
  - ```{autodoc2-docstring} pyirk.visualization.create_nx_graph_from_entity
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyirk.visualization.__all__
:value: >
   ['visualize_entity', 'visualize_all_entities']

```{autodoc2-docstring} pyirk.visualization.__all__
```

````

````{py:data} REPLACEMENTS
:canonical: pyirk.visualization.REPLACEMENTS
:value: >
   None

```{autodoc2-docstring} pyirk.visualization.REPLACEMENTS
```

````

````{py:data} FONTSIZE
:canonical: pyirk.visualization.FONTSIZE
:value: >
   16

```{autodoc2-docstring} pyirk.visualization.FONTSIZE
```

````

````{py:data} NEWLINE_REPLACEMENTS
:canonical: pyirk.visualization.NEWLINE_REPLACEMENTS
:value: >
   [('__newline-center__', '\\n'), ('__newline-left__', '\\l')]

```{autodoc2-docstring} pyirk.visualization.NEWLINE_REPLACEMENTS
```

````

````{py:data} mpl_colors
:canonical: pyirk.visualization.mpl_colors
:value: >
   ['#ff7f0e', '#1f77b4', '#2ca02c', '#d62728', '#9467bd', '#8c564b', '#e377c2', '#7f7f7f', '#bcbd22', ...

```{autodoc2-docstring} pyirk.visualization.mpl_colors
```

````

`````{py:class} AbstractGraphObject()
:canonical: pyirk.visualization.AbstractGraphObject

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject.__init__
```

````{py:method} _perform_label_segmentation() -> None
:canonical: pyirk.visualization.AbstractGraphObject._perform_label_segmentation

```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject._perform_label_segmentation
```

````

````{py:method} __repr__() -> str
:canonical: pyirk.visualization.AbstractGraphObject.__repr__

````

````{py:method} get_dot_label()
:canonical: pyirk.visualization.AbstractGraphObject.get_dot_label

```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject.get_dot_label
```

````

````{py:method} perform_html_wrapping(use_html=True) -> None
:canonical: pyirk.visualization.AbstractGraphObject.perform_html_wrapping

```{autodoc2-docstring} pyirk.visualization.AbstractGraphObject.perform_html_wrapping
```

````

`````

````{py:function} key_generator(template='k{:04d}')
:canonical: pyirk.visualization.key_generator

```{autodoc2-docstring} pyirk.visualization.key_generator
```
````

````{py:data} label_segment_key_gen
:canonical: pyirk.visualization.label_segment_key_gen
:value: >
   'key_generator(...)'

```{autodoc2-docstring} pyirk.visualization.label_segment_key_gen
```

````

````{py:data} literal_node_key_gen
:canonical: pyirk.visualization.literal_node_key_gen
:value: >
   'key_generator(...)'

```{autodoc2-docstring} pyirk.visualization.literal_node_key_gen
```

````

````{py:data} relation_key_gen
:canonical: pyirk.visualization.relation_key_gen
:value: >
   'key_generator(...)'

```{autodoc2-docstring} pyirk.visualization.relation_key_gen
```

````

`````{py:class} EntityNode(entity: pyirk.Entity, url_template: str)
:canonical: pyirk.visualization.EntityNode

Bases: {py:obj}`pyirk.visualization.AbstractGraphObject`

```{autodoc2-docstring} pyirk.visualization.EntityNode
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.visualization.EntityNode.__init__
```

````{py:method} get_dot_label(render=False) -> str
:canonical: pyirk.visualization.EntityNode.get_dot_label

```{autodoc2-docstring} pyirk.visualization.EntityNode.get_dot_label
```

````

````{py:method} get_color() -> str
:canonical: pyirk.visualization.EntityNode.get_color

```{autodoc2-docstring} pyirk.visualization.EntityNode.get_color
```

````

`````

`````{py:class} LiteralStrNode(arg: str)
:canonical: pyirk.visualization.LiteralStrNode

Bases: {py:obj}`pyirk.visualization.AbstractGraphObject`

````{py:method} __repr__() -> str
:canonical: pyirk.visualization.LiteralStrNode.__repr__

````

````{py:method} get_dot_label()
:canonical: pyirk.visualization.LiteralStrNode.get_dot_label

```{autodoc2-docstring} pyirk.visualization.LiteralStrNode.get_dot_label
```

````

`````

`````{py:class} Edge(relation: pyirk.Relation, url_template: str)
:canonical: pyirk.visualization.Edge

Bases: {py:obj}`pyirk.visualization.AbstractGraphObject`

```{autodoc2-docstring} pyirk.visualization.Edge
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.visualization.Edge.__init__
```

````{py:method} _perform_label_segmentation() -> None
:canonical: pyirk.visualization.Edge._perform_label_segmentation

````

````{py:method} get_dot_label()
:canonical: pyirk.visualization.Edge.get_dot_label

```{autodoc2-docstring} pyirk.visualization.Edge.get_dot_label
```

````

````{py:method} get_color() -> str
:canonical: pyirk.visualization.Edge.get_color

```{autodoc2-docstring} pyirk.visualization.Edge.get_color
```

````

`````

````{py:function} create_node(arg: typing.Union[pyirk.Entity, object], url_template: str) -> pyirk.visualization.AbstractGraphObject
:canonical: pyirk.visualization.create_node

```{autodoc2-docstring} pyirk.visualization.create_node
```
````

````{py:function} create_key_with_length(basic_key_gen: callable, length: int) -> str
:canonical: pyirk.visualization.create_key_with_length

```{autodoc2-docstring} pyirk.visualization.create_key_with_length
```
````

````{py:function} create_label_segments(short_key: str, label: str, maxlen: int) -> typing.Tuple[typing.List[str], typing.List[str]]
:canonical: pyirk.visualization.create_label_segments

```{autodoc2-docstring} pyirk.visualization.create_label_segments
```
````

`````{py:class} CustomizedDiGraph(incoming_graph_data=None, multigraph_input=None, **attr)
:canonical: pyirk.visualization.CustomizedDiGraph

Bases: {py:obj}`networkx.MultiDiGraph`

````{py:method} add_node(node: pyirk.visualization.AbstractGraphObject, **kwargs)
:canonical: pyirk.visualization.CustomizedDiGraph.add_node

````

`````

`````{py:class} VisualizationManager()
:canonical: pyirk.visualization.VisualizationManager

```{autodoc2-docstring} pyirk.visualization.VisualizationManager
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.__init__
```

````{py:method} create_nx_graph_from_entity(uri, url_template='') -> networkx.DiGraph
:canonical: pyirk.visualization.VisualizationManager.create_nx_graph_from_entity

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.create_nx_graph_from_entity
```

````

````{py:method} get_color_for_item(item: pyirk.Item) -> str
:canonical: pyirk.visualization.VisualizationManager.get_color_for_item

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.get_color_for_item
```

````

````{py:method} get_color_for_stm(stm: pyirk.Statement) -> str
:canonical: pyirk.visualization.VisualizationManager.get_color_for_stm

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.get_color_for_stm
```

````

````{py:method} create_complete_graph(url_template='', limit: typing.Optional[int] = None, skip_auto_items: bool = False, vis_relations: bool = False, item_blacklist: list = []) -> networkx.DiGraph
:canonical: pyirk.visualization.VisualizationManager.create_complete_graph

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.create_complete_graph
```

````

````{py:method} render_graph_to_dot(G: networkx.DiGraph, center_node=None) -> str
:canonical: pyirk.visualization.VisualizationManager.render_graph_to_dot

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.render_graph_to_dot
```

````

````{py:method} build_edge_color_map(G)
:canonical: pyirk.visualization.VisualizationManager.build_edge_color_map

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.build_edge_color_map
```

````

````{py:method} svg_replace(raw_svg_data: str, REPLACEMENTS: dict) -> str
:canonical: pyirk.visualization.VisualizationManager.svg_replace

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.svg_replace
```

````

````{py:method} visualize_entity(uri: str, url_template='', write_tmp_files: typing.Union[bool, str] = False, radius=1, graph=None, vis_relations=False, skip_auto_items=True, item_blacklist=[]) -> str
:canonical: pyirk.visualization.VisualizationManager.visualize_entity

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.visualize_entity
```

````

````{py:method} add_legend(svg_data, relation_color_map, list_of_relations)
:canonical: pyirk.visualization.VisualizationManager.add_legend

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.add_legend
```

````

````{py:method} get_label(entity)
:canonical: pyirk.visualization.VisualizationManager.get_label

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.get_label
```

````

````{py:method} visualize_all_entities(url_template='', write_tmp_files: typing.Union[bool, str] = False, skip_auto_items: bool = False, vis_relations=False) -> str
:canonical: pyirk.visualization.VisualizationManager.visualize_all_entities

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.visualize_all_entities
```

````

````{py:method} save_data_to_file(mode, dot_data, svg_data, svg_data_legend=None)
:canonical: pyirk.visualization.VisualizationManager.save_data_to_file

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.save_data_to_file
```

````

````{py:method} render_label(label: str)
:canonical: pyirk.visualization.VisualizationManager.render_label

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.render_label
```

````

````{py:method} create_interactive_graph(url_template='', output_dir='graph_site', radius=1, skip_auto_items=True, skip_existing=False, vis_relations=False)
:canonical: pyirk.visualization.VisualizationManager.create_interactive_graph

```{autodoc2-docstring} pyirk.visualization.VisualizationManager.create_interactive_graph
```

````

`````

````{py:data} vm
:canonical: pyirk.visualization.vm
:value: >
   'VisualizationManager(...)'

```{autodoc2-docstring} pyirk.visualization.vm
```

````

````{py:data} visualize_entity
:canonical: pyirk.visualization.visualize_entity
:value: >
   None

```{autodoc2-docstring} pyirk.visualization.visualize_entity
```

````

````{py:data} visualize_all_entities
:canonical: pyirk.visualization.visualize_all_entities
:value: >
   None

```{autodoc2-docstring} pyirk.visualization.visualize_all_entities
```

````

````{py:data} create_nx_graph_from_entity
:canonical: pyirk.visualization.create_nx_graph_from_entity
:value: >
   None

```{autodoc2-docstring} pyirk.visualization.create_nx_graph_from_entity
```

````