# {py:mod}`simvx.core.selection`

```{py:module} simvx.core.selection
```

```{autodoc2-docstring} simvx.core.selection
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Selection <simvx.core.selection.Selection>`
  - ```{autodoc2-docstring} simvx.core.selection.Selection
    :summary:
    ```
````

### API

`````{py:class} Selection()
:canonical: simvx.core.selection.Selection

```{autodoc2-docstring} simvx.core.selection.Selection
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.selection.Selection.__init__
```

````{py:property} items
:canonical: simvx.core.selection.Selection.items
:type: list

```{autodoc2-docstring} simvx.core.selection.Selection.items
```

````

````{py:property} count
:canonical: simvx.core.selection.Selection.count
:type: int

```{autodoc2-docstring} simvx.core.selection.Selection.count
```

````

````{py:property} primary
:canonical: simvx.core.selection.Selection.primary
:type: object | None

```{autodoc2-docstring} simvx.core.selection.Selection.primary
```

````

````{py:property} empty
:canonical: simvx.core.selection.Selection.empty
:type: bool

```{autodoc2-docstring} simvx.core.selection.Selection.empty
```

````

````{py:method} select(item, *, additive: bool = False)
:canonical: simvx.core.selection.Selection.select

```{autodoc2-docstring} simvx.core.selection.Selection.select
```

````

````{py:method} deselect(item)
:canonical: simvx.core.selection.Selection.deselect

```{autodoc2-docstring} simvx.core.selection.Selection.deselect
```

````

````{py:method} toggle(item)
:canonical: simvx.core.selection.Selection.toggle

```{autodoc2-docstring} simvx.core.selection.Selection.toggle
```

````

````{py:method} clear()
:canonical: simvx.core.selection.Selection.clear

```{autodoc2-docstring} simvx.core.selection.Selection.clear
```

````

````{py:method} select_all(items)
:canonical: simvx.core.selection.Selection.select_all

```{autodoc2-docstring} simvx.core.selection.Selection.select_all
```

````

````{py:method} is_selected(item) -> bool
:canonical: simvx.core.selection.Selection.is_selected

```{autodoc2-docstring} simvx.core.selection.Selection.is_selected
```

````

````{py:method} __contains__(item)
:canonical: simvx.core.selection.Selection.__contains__

```{autodoc2-docstring} simvx.core.selection.Selection.__contains__
```

````

````{py:method} __iter__()
:canonical: simvx.core.selection.Selection.__iter__

```{autodoc2-docstring} simvx.core.selection.Selection.__iter__
```

````

````{py:method} __len__() -> int
:canonical: simvx.core.selection.Selection.__len__

```{autodoc2-docstring} simvx.core.selection.Selection.__len__
```

````

`````