Skip to content

Commit 87b466c

Browse files
updated docs with .xlsx and other finer UX bits
1 parent b046127 commit 87b466c

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
# vscode-data-preview
22
[VSCode](https://github.com/Microsoft/vscode) Data Preview extension for viewing, slicing and dicing
3-
large `.csv`, `.json` array, `.arrow` and `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.
3+
large `.csv`, `.xlsx`, `.json` array, `.arrow` and `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.
44

55
![Data Preview](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview.png?raw=true
66
"Data Preview")
77

8-
## Usage Tips:
8+
## Data Preview Launch Tips:
99

10-
1. Hit `Ctrl+Shift+D` in open `.csv` or `.json` array data file to launch Data Preview panel.
11-
2. Hit `Ctrl+S` or Save your `.csv` or `.json` array data file for data refresh in open Data Preview panel.
12-
3. Right-click on `.arrow` data file in vscode file explorer to lauch Data Preview for these binary data files.
13-
4. Double click on the grid column header to sort data.
14-
5. Drag and drop columns from the left-side columns panel into filter fields for data filtering (group by, split by, sort, filter).
10+
1. Hit `Ctrl+Shift+D` in an open text `.csv` or `.json` array data file document to launch Data Preview panel.
11+
2. Hit `Ctrl+S` or `File -> Save` your `.csv` or `.json` array data file for updates in open Data Preview panel.
12+
3. Right-click on a binary `.xlsx` or `.arrow` data file in vscode File Explorer to launch Data Preview panel.
13+
4. Use exposed `editor/title` or `editor/title/context` context menu options to Preview your data files.
14+
15+
## Data Grid/Filter/Columns UX Tips:
16+
17+
1. Double click on the grid column header to `Sort` data by that column.
18+
2. Drag and drop a column from the left-side `Columns` control panel into `Filter fields` for data filtering
19+
(`Group By`, `Split By`, `Sort`, `Filter`).
20+
3. Drag columns up and down in the left-side `Columns` control panel to reorder displayed columns in the Data Grid.
21+
4. Uncheck a column in the `Columns` control panel to remove it from a Chart or Data Grid display.
1522

1623
# MVP Features
1724

18-
- CSV, JSON array, and Arrow data preview, sorting and filtering
19-
- Grid data summary display with aggregate functions, row and column pivots (a.k.a. groupBy and splitBy)
20-
- Basic charts auto-gen from data with aggregate functions, row and column pivots
21-
- Pluggable charting libraries for stock charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
22-
- Dark and light data preview panel themes
25+
- `CSV`, `XLSX`, `JSON array`, and `Arrow` data files preview, sorting and filtering
26+
- Grid data summary display with Aggregate Functions, row and column pivots (a.k.a. `Group By` and `Split By`)
27+
- Basic Charts auto-gen from data with Aggregate Functions, row and column pivots
28+
- Pluggable charting libraries for stock Charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
29+
- Dark and Light Data Preview panel themes
2330
- Persistent Data Preview settings (sort, filter, pivots, etc.) for restore on vscode reload
2431

2532
![Perspective Viewer](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/perspective-viewer.gif?raw=true

0 commit comments

Comments
 (0)