Skip to content

Commit

Permalink
#17 docs & pics update for extended data files support release
Browse files Browse the repository at this point in the history
  • Loading branch information
RandomFractals committed May 30, 2019
1 parent 88690c5 commit 51014f7
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 21 deletions.
58 changes: 37 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,15 @@
# vscode-data-preview
[VSCode](https://github.com/Microsoft/vscode) Data Preview extension for viewing, slicing and dicing
large `.csv`, `.xlsx`, `.json` array, `.arrow` and `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.
large `.csv/.tsv`, `.xlsx/.xlsm`, `.json` array, `.arrow` and `.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.

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

## Data Preview Launch Tips:

1. Hit `Ctrl+Shift+D` in an open text `.csv` or `.json` array data file document to launch Data Preview panel.
2. Hit `Ctrl+S` or `File -> Save` your `.csv` or `.json` array data file for updates in open Data Preview panel.
3. Right-click on a binary `.xlsx` or `.arrow` data file in vscode File Explorer to launch Data Preview panel.
4. Use exposed `editor/title` or `editor/title/context` context menu options to Preview your data files.

## Data Grid/Filter/Columns UX Tips:

1. Double click on the grid column header to `Sort` data by that column.
2. Drag and drop a column from the left-side `Columns` control panel into `Filter fields` for data filtering
(`Group By`, `Split By`, `Sort`, `Filter`).
3. Drag columns up and down in the left-side `Columns` control panel to reorder displayed columns in the Data Grid.
4. Uncheck a column in the `Columns` control panel to remove it from a Chart or Data Grid display.

# MVP Features

- `CSV`, `XLSX`, `JSON array`, and `Arrow` data files preview, sorting and filtering
- Grid data summary display with Aggregate Functions, row and column pivots (a.k.a. `Group By` and `Split By`)
- Basic Charts auto-gen from data with Aggregate Functions, row and column pivots
- `CSV/TSV`, `XLSX/XLSM`, `JSON array`, and `Arrow` data files preview, sorting and filtering
- Grid Data summary display with Aggregate Functions, Row and Column Pivots (a.k.a. `Group By` and `Split By`)
- Basic Charts auto-gen from data with Aggregate Functions, Row and Column Pivots
- Pluggable charting libraries for stock Charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
- Dark and Light Data Preview panel themes
- Persistent Data Preview settings (sort, filter, pivots, etc.) for restore on vscode reload
Expand All @@ -34,13 +19,13 @@ large `.csv`, `.xlsx`, `.json` array, `.arrow` and `.parquet` data files with [P

# Next V.

- Will include large data files support and [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.
- Will include `.parquet`, large text and binary data files support, and [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.

# Installation

Install this [Data Preview](https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.vscode-data-preview) via vscode Extensions tab (`Ctrl+Shift+X`) by searching for `data preview`, or via [vscode marketplace search results](https://marketplace.visualstudio.com/search?term=data%20preview&target=VSCode&category=All%20categories&sortBy=Relevance).

List of Data Preview extension vscode contributions, with `data.preview` command, keyboard shortcut, augmented menu contexts for `csv` and `json` array data file previews, and configurable theme and charts data preview settings:
List of Data Preview extension vscode contributions, with `data.preview` command, keyboard shortcut, augmented menu contexts for `csv/tsv`, `xlsx/xlsm`, `json` array, and `arrow` data file previews, and configurable theme and charts data preview settings:

![Data Preview Contributions](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-contributions.png?raw=true
"Data Preview Contributions")
Expand All @@ -59,6 +44,37 @@ Data Preview using `.dark` theme with `d3fc` charts config, viewing
![Data Preview Dark](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview-dark.png?raw=true
"Data Preview Dark")

# Usage Tips

## Data Preview Launch Tips

1. Run `View -> Command Palette>Data: Preview Data 🈸` command or hit `Ctrl+Shift+D` in an open text `.csv/.tsv` or `.json` array data file document to launch Data Preview panel.
2. Hit `Ctrl+S` or `File -> Save` your `.csv/.tsv` or `.json` array data file for updates in open Data Preview panel.
3. Right-click on a binary `.xlsx/.xlsm` or `.arrow` data file in vscode File Explorer to launch Data Preview panel.
4. Use exposed `explorer/context`, `editor/title` or `editor/title/context` context menu options to Preview your data files.

## Data Grid/Filter/Columns UX Tips

1. Double click on the Grid Column header to `Sort` data by that column.
2. Drag and drop a column from the left-side `Columns` control panel into `Filter fields` for data filtering
(`Group By`, `Split By`, `Sort`, `Filter`).
3. Drag columns up and down in the left-side `Columns` control panel to reorder displayed columns in the Data Grid.
4. Uncheck a column in the `Columns` control panel to remove it from a Chart or Data Grid display.

# Supported Excel & Other Binary Data Formats

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

```js
{
"when": "resourceFilename =~ /.*\\.(csv|tsv|txt|tab|dif|ods|prn|slk|xls|xlsb|xlsx|xlsm|xml|html|json|arrow|arr|parquet|parq)/",
"command": "data.preview",
"group": "navigation"
}
```

See https://github.com/SheetJS/js-xlsx#file-formats for more info on supported `Excel` file formats.

## Provided Chart Types

Expand Down
Binary file added images/vscode-data-preview-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 51014f7

Please sign in to comment.