Skip to content

Commit aebdc31

Browse files
author
Chris DeMartini
authored
Merge pull request #4 from uber/feat/docs
Feat/docs
2 parents 342e35c + 4f30b1c commit aebdc31

File tree

6 files changed

+50
-0
lines changed

6 files changed

+50
-0
lines changed

docs/Picture1.png

172 KB
Loading

docs/Picture2.png

152 KB
Loading

docs/Picture3.png

167 KB
Loading

docs/Picture4.png

193 KB
Loading

docs/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Kepler.gl for Tableau User Guide
2+
3+
## Instructions
4+
5+
###### Env Requirements
6+
Tableau Desktop (Mac Only) 2018.3 or >= 2019.1.2 and Tableau Server
7+
8+
*Tableau extensions are only supported in Tableau Desktop and Tableau Server, not supported in Tableau Public. WebGL is only supported in Tableau on Mac, version 2018.3 or >= 2019.1.2.*
9+
10+
###### Step 1: Download Kepler Tableau Extension from [Dropbox](https://www.dropbox.com/s/ubvopxvjo2dencv/datablick-kepler-gl.trex.zip?dl=0) or [Github](https://github.com/uber/kepler.gl-tableau/tree/master/public)
11+
12+
Note: You will likely want to save your extension file into your My Tableau Repository/Extensions folder.
13+
14+
###### Step 2: Extensions will only work on a Tableau “Dashboard”. Once you have created a dashboard and loaded at least 1 sheet with data onto it you can then drag the ‘Extension’ button from the bottom left of the toolbar to any spot on the Dashboard pane. You will then see this prompt and can click the ‘My Extensions’ button.
15+
16+
![Tableau Dashboard 1](Picture1.png)
17+
18+
###### Step 3: Locate the Downloaded Tableau extension file (.trex) (if you followed our suggestion above it will be in My Tableau Repository/Extensions)
19+
20+
![Tableau Dashboard 2](Picture2.png)
21+
22+
###### Step 4: You will then be prompted for permitting the extension to run. Click ‘Allow’
23+
24+
![Tableau Dashboard 3](Picture3.png)
25+
26+
###### Step 5: Custom configurations
27+
28+
The configuration capabilities of the extension will change over time, however, you will be able to set multiple configurations on your way into [kepler.gl](https://kepler.gl/) within Tableau. Each of these options also has a help description in the ? attached to each title. This content should explain what the purpose of the configuration is. If this is unclear to you during your use it would be great for us to know that we need to provide more guidance in this configuration screen.
29+
30+
![Tableau Dashboard 4](Picture4.png)
31+
32+
###### Step 6: Using [kepler.gl](https://kepler.gl/) within Tableau
33+
34+
At this point you can use [kepler.gl](https://kepler.gl/) as you normally would. If you need additional detail on how to use [kepler.gl](https://kepler.gl/) to begin with, please visit the kepler.gl demo and guidance documentation at https://kepler.gl/.
35+
36+
37+
###### Step 7: Submit Feedback and Help us Test!
38+
39+
For feedback/ feature requests, please let us know through this Kepler Tableau Slack Channel. We also encourage you to share your maps here to the rest of the map enthusiasts in the room too.
40+
41+
![Testing Pic](Testing.png)
42+
43+
Useful Links
44+
45+
- [Extension file](https://www.dropbox.com/s/ubvopxvjo2dencv/datablick-kepler-gl.trex.zip?dl=0)
46+
- [Kepler.gl User Guide](https://github.com/keplergl/kepler.gl/blob/master/docs/user-guides/a-introduction.md)
47+
- [Kepler.gl in Tableau Slack Channel](http://t.uber.com/kepler.gl-tableau)
48+
- [Presentation by Shan and Chris at SFBATUG](https://vimeo.com/332524556/36fd0b2cbe) start at 58 minutes
49+
50+
Happy Mapping :)

docs/Testing.png

968 KB
Loading

0 commit comments

Comments
 (0)