You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-26Lines changed: 28 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,57 +1,59 @@
1
1
# vscode-data-preview
2
-
[VSCode](https://github.com/Microsoft/vscode) Data Preview extension for viewing, slicing and dicing
3
-
large `.csv/.tsv`, `.xlsx/.xlsm`, `.json` array, `.arrow`and`.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming analytics WebAssembly library.
2
+
[VSCode](https://github.com/Microsoft/vscode) Data Preview 🈸 extension for viewing, slicing & dicing
3
+
large `.csv/.tsv`, `.xlsx/.xlsm`, `.json` array, `.arrow`&`.parquet` data files with [Perspective](https://perspective.finos.org/) - streaming data analytics WebAssembly library.
- Will include `.parquet`, large text and binary data files support, and [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.
22
+
- Will include `.parquet` data format support, large text & binary data files loading & [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data streaming.
23
+
24
+
**Note:** this Data Preview 🈸 MVP v. is already capable of loading a few MB's large data files with 100+K records & extensive list of supported data formats you'll be hard pressed to find on vscode marketplace.
23
25
24
26
# Installation
25
27
26
-
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).
28
+
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` || via [vscode marketplace search results](https://marketplace.visualstudio.com/search?term=data%20preview&target=VSCode&category=All%20categories&sortBy=Relevance).
27
29
28
-
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:
30
+
List of Data Preview 🈸 extension vscode contributions, with `data.preview` command, keyboard shortcut, augmented vscode UI context menus, added data language mappings, supported data files list & configurable theme & charts Data Preview 🈸 Settings:
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change default Data Preview extension settings:
36
+
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change default Data Preview 🈸 extension Settings:
35
37
36
38
Setting | Type | Default Value | Description
37
39
------- | ---- | ------------- | -----------
38
40
data.preview.theme | string | | Data Preview theme: blank for light, or '.dark' for dark theme data previews display.
39
-
data.preview.charts.plugin | string | hightcharts | Data Preview charts library to use for stock charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
41
+
data.preview.charts.plugin | string | hightcharts | Data Preview 🈸 charts library to use for stock charts: [highcharts](https://www.highcharts.com/demo) or [d3fc](https://d3fc.io/)
40
42
41
-
Data Preview using `.dark` theme with `d3fc` charts config, viewing
43
+
Data Preview 🈸 example using `.dark` theme with `d3fc` charts config, viewing
42
44
[superstore](https://github.com/finos/perspective/blob/master/examples/simple/superstore.arrow)`.arrow` data file :)
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.
52
-
2. Hit `Ctrl+S` or `File -> Save` your `.csv/.tsv` or `.json` array data file for updates in open Data Preview panel.
53
-
3. Right-click on a binary `.xlsx/.xlsm` or `.arrow` data file in vscode File Explorer to launch Data Preview panel.
54
-
4. Use exposed `explorer/context`, `editor/title` or `editor/title/context` context menu options to Preview your data files.
53
+
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.
54
+
2. Hit `Ctrl+S` or `File -> Save` your `.csv/.tsv` or `.json` array data file for updates in open Data Preview 🈸 panel.
55
+
3. Right-click on a binary `.xlsx/.xlsm` or `.arrow` data file in vscode File Explorer to launch Data Preview 🈸 panel.
56
+
4. Use exposed `explorer/context`, `editor/title` or `editor/title/context` context menu options to Preview 🈸 your data files.
55
57
56
58
## Data Grid/Filter/Columns UX Tips
57
59
@@ -63,9 +65,6 @@ Data Preview using `.dark` theme with `d3fc` charts config, viewing
@@ -110,7 +112,7 @@ See https://github.com/SheetJS/js-xlsx#file-formats for more info on supported `
110
112
111
113
# Dev Log
112
114
113
-
See [#DataPreview tag on Twitter](https://twitter.com/hashtag/datapreview?f=tweets&vertical=default&src=hash) for the latest and greatest updates on this vscode extension and what's in store next.
115
+
See [#DataPreview 🈸 tag on Twitter](https://twitter.com/hashtag/datapreview?f=tweets&vertical=default&src=hash) for the latest and greatest updates on this vscode extension and what's in store next.
114
116
115
117
# Dev Build
116
118
@@ -120,10 +122,10 @@ $ cd vscode-data-preview
120
122
$ npm install
121
123
$ code .
122
124
```
123
-
`F5` to launch Data Preview extension VSCode debug session.
125
+
`F5` to launch Data Preview 🈸 extension VSCode debug session.
124
126
125
127
# Contributions
126
128
127
129
Any and all test, code or feedback contributions are welcome.
128
130
129
-
Open an issue or create a pull request to make this Data Preview extension work better for all.
131
+
Open an issue or create a pull request to make this Data Preview 🈸 extension work better for all.
0 commit comments