# vue-tableau

> Vue.js component for integrating the [Tableau API](https://onlinehelp.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_ref.htm).

Latest version **0.1.7** (published 2019-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-tableau
pnpm add vue-tableau
yarn add vue-tableau
bun add vue-tableau
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.7 |
| Published | 2019-04-09 |
| First published | 2018-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jerry Xie |
| Maintainers | thecoldhouse |
| Keywords | vue, tableau |

## Links

- npm: https://www.npmjs.com/package/vue-tableau
- Repository: https://github.com/JerryXie98/vue-tableau
- Homepage: https://github.com/JerryXie98/vue-tableau#readme
- Issues: https://github.com/JerryXie98/vue-tableau/issues
- npm.io page: https://npm.io/package/vue-tableau

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.5.16

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 0.1.7 (latest) — 2019-04-09
- 0.1.6 — 2019-04-09
- 0.1.5 — 2018-09-06
- 0.1.4 — 2018-08-03
- 0.1.3 — 2018-07-25
- 0.1.2 — 2018-07-22
- 0.1.1 — 2018-07-21
- 0.1.0 — 2018-07-21

## README

# vue-tableau
Vue.js component for integrating the [Tableau API](https://onlinehelp.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_ref.htm).

## Installation
```
yarn add vue-tableau
```

## Basic Usage

### main.js
Import vue-tableau within your javascript entry point.
``` javascript
import 'vue-tableau'
```
Now you are free to use the component wherever.

The following is a simple example:
``` html
<Tableau 
    :url="url" 
    :height="1000" 
    :width="1000" 
    :filters="{
        Storm Name': ['CELIA', 'BLAS', 'AGATHA'],
        'Basin': 'East Pacific'
    }" 
    ref="tableau">
</Tableau>
```

![alt text](src/assets/TableauExample.png)

### Documentation
The following props can be passed in and are automatically handled by the Tableau component:
- url
- height 
- width
- filters
- options (can specify constructor options explicity as documented [here](https://onlinehelp.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_ref.htm#ref_head_9)

The following classes along with all of their methods are accessible through vue refs:

- viz
- workBook
- workSheet

Example:
``` javascript
this.$refs['tableau'].workBook.getName() 
```

Please refer to the [Tableau API Documentation](https://onlinehelp.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api_ref.htm) for more details regarding all the methods available.

---
_Source: https://npm.io/package/vue-tableau · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._