# {py:mod}`simvx.core.ui.markers`

```{py:module} simvx.core.ui.markers
```

```{autodoc2-docstring} simvx.core.ui.markers
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`TextMarker <simvx.core.ui.markers.TextMarker>`
  - ```{autodoc2-docstring} simvx.core.ui.markers.TextMarker
    :summary:
    ```
* - {py:obj}`MarkerMixin <simvx.core.ui.markers.MarkerMixin>`
  - ```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.ui.markers.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.markers.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.ui.markers.__all__
:value: >
   ['TextMarker', '_MARKER_COLOURS']

```{autodoc2-docstring} simvx.core.ui.markers.__all__
```

````

`````{py:class} TextMarker
:canonical: simvx.core.ui.markers.TextMarker

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker
```

````{py:attribute} line
:canonical: simvx.core.ui.markers.TextMarker.line
:type: int
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.line
```

````

````{py:attribute} col_start
:canonical: simvx.core.ui.markers.TextMarker.col_start
:type: int
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.col_start
```

````

````{py:attribute} col_end
:canonical: simvx.core.ui.markers.TextMarker.col_end
:type: int
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.col_end
```

````

````{py:attribute} type
:canonical: simvx.core.ui.markers.TextMarker.type
:type: str
:value: >
   'error'

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.type
```

````

````{py:attribute} colour
:canonical: simvx.core.ui.markers.TextMarker.colour
:type: tuple[float, float, float, float]
:value: >
   (1.0, 0.2, 0.2, 0.6)

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.colour
```

````

````{py:attribute} tooltip
:canonical: simvx.core.ui.markers.TextMarker.tooltip
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} simvx.core.ui.markers.TextMarker.tooltip
```

````

`````

`````{py:class} MarkerMixin
:canonical: simvx.core.ui.markers.MarkerMixin

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin
```

````{py:method} add_marker(line: int, col_start: int, col_end: int, type: str = 'error', colour: tuple[float, float, float, float] | None = None, tooltip: str = '') -> simvx.core.ui.markers.TextMarker
:canonical: simvx.core.ui.markers.MarkerMixin.add_marker

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin.add_marker
```

````

````{py:method} remove_marker(marker: simvx.core.ui.markers.TextMarker)
:canonical: simvx.core.ui.markers.MarkerMixin.remove_marker

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin.remove_marker
```

````

````{py:method} clear_markers(type: str | None = None)
:canonical: simvx.core.ui.markers.MarkerMixin.clear_markers

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin.clear_markers
```

````

````{py:method} get_markers(line: int | None = None) -> list[simvx.core.ui.markers.TextMarker]
:canonical: simvx.core.ui.markers.MarkerMixin.get_markers

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin.get_markers
```

````

````{py:method} set_hover_tooltip(text: str, line: int, col: int)
:canonical: simvx.core.ui.markers.MarkerMixin.set_hover_tooltip

```{autodoc2-docstring} simvx.core.ui.markers.MarkerMixin.set_hover_tooltip
```

````

`````