@panoramax/web-viewer
Version:
Panoramax web viewer for geolocated pictures
98 lines (68 loc) • 3.85 kB
Markdown
<a name="Panoramax.components.menus.SemanticsList"></a>
## Panoramax.components.menus.SemanticsList ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
**Kind**: static class of <code>Panoramax.components.menus</code>
**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
**Emits**: [<code>select</code>](#Panoramax.components.menus.SemanticsList+event_select), [<code>edit-click</code>](#Panoramax.components.menus.SemanticsList+event_edit-click), [<code>delete-click</code>](#Panoramax.components.menus.SemanticsList+event_delete-click)
**Element**: pnx-semantics-list
* [.SemanticsList](#Panoramax.components.menus.SemanticsList) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
* [new SemanticsList()](#new_Panoramax.components.menus.SemanticsList_new)
* [.properties](#Panoramax.components.menus.SemanticsList+properties) : <code>Object</code>
* [.showAnnotation(id)](#Panoramax.components.menus.SemanticsList+showAnnotation)
* [.showTagsGroup(tags)](#Panoramax.components.menus.SemanticsList+showTagsGroup)
* ["select"](#Panoramax.components.menus.SemanticsList+event_select)
* ["edit-click"](#Panoramax.components.menus.SemanticsList+event_edit-click)
* ["delete-click"](#Panoramax.components.menus.SemanticsList+event_delete-click)
<a name="new_Panoramax.components.menus.SemanticsList_new"></a>
### new SemanticsList()
Semantics list shows listing of both picture tags and annotations.
It uses the parent component currently selected picture.
**Example**
```html
<pnx-semantics-list _parent=${viewer} />
```
<a name="Panoramax.components.menus.SemanticsList+properties"></a>
### semanticsList.properties : <code>Object</code>
Component properties.
**Kind**: instance property of [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [editable] | <code>boolean</code> | <code>false</code> | Show an "Edit" button ? |
<a name="Panoramax.components.menus.SemanticsList+showAnnotation"></a>
### semanticsList.showAnnotation(id)
Display a specific annotation details.
**Kind**: instance method of [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
| Param | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | The annotation UUID |
<a name="Panoramax.components.menus.SemanticsList+showTagsGroup"></a>
### semanticsList.showTagsGroup(tags)
Display a specific tag group details.
**Kind**: instance method of [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
| Param | Type | Description |
| --- | --- | --- |
| tags | <code>object</code> | The tags to find |
<a name="Panoramax.components.menus.SemanticsList+event_select"></a>
### "select"
Event for item selection
**Kind**: event emitted by [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| detail.item | <code>object</code> | The selected annotation/tag group (or null if none) |
<a name="Panoramax.components.menus.SemanticsList+event_edit-click"></a>
### "edit-click"
Event for edit button click
**Kind**: event emitted by [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| detail.item | <code>object</code> | The annotation/tag group to edit |
<a name="Panoramax.components.menus.SemanticsList+event_delete-click"></a>
### "delete-click"
Event for delete button click
**Kind**: event emitted by [<code>SemanticsList</code>](#Panoramax.components.menus.SemanticsList)
**Properties**
| Name | Type | Description |
| --- | --- | --- |
| detail.item | <code>object</code> | The annotation/tag group to delete |