docs: add current selections (#351)

This commit is contained in:
Miralem Drek
2020-03-12 12:46:50 +01:00
committed by GitHub
parent 3296737667
commit 03469c196a
5 changed files with 43 additions and 3 deletions

View File

@@ -1,6 +1,46 @@
---
id: app-selections
title: App selections
title: Current app selections
---
TODO
An essential part of the Qlik experience is filtering data through selections. Most charts support selections in the data they render, which will then filter out data and affect other charts connected to the same data model.
## Current app selections bar
The current app selections bar shows you the currently active selections in the specified app. To render this bar you need an `HTMLElement` first:
```html
<div class="curr-selections"></div>
```
You can then `mount` the selections UI into that element:
```js
const n = nucleus(enigmaApp);
await (n.selections()).mount(document.querySelector('.curr-selections');
```
Without any selections it should like this:
![Empty selections bar](assets/selections-empty.png)
As you start applying selections in the various charts, the UI will update to reflect the current state:
![Update selections bar](assets/selections-update.gif)
## Multiple bars
If you are connected to multiple apps, you can show the current selections in each one by mounting the bar into different elements:
```js
await nucleus(enigmaApp)
.selections()
.mount(document.querySelector('.curr-selections'));
await nucleus(anotherApp, { context: { theme: 'dark' } })
.selections()
.mount(document.querySelector('.another-curr-selections'));
```
![Multiple selections](assets/selections-multiple.gif)

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 334 KiB

View File

@@ -6,7 +6,7 @@
"tagline": "A new star on the rise",
"docs": {
"app-selections": {
"title": "App selections"
"title": "Current app selections"
},
"installation": {
"title": "Installation"