Skip to content

Commit 0900b6d

Browse files
trim settings keys in docs for better display in marketplace (#110)
and add a note about it to Settings section in docs.
1 parent 51eeec1 commit 0900b6d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ See [Data Preview](https://github.com/RandomFractals/vscode-data-preview) 🈸 v
4444

4545
# Limitations
4646

47-
Large CSV data files streaming and display is very alpha and has the following limitations for now:
47+
Large CSV/TSV data files streaming and display is very alpha and has the following limitations for now:
4848

4949
- Large datasets are paged and loaded into view for display with default page size set to 100K rows per page
5050
- Columns sort only works for the paged data loaded and displayed in Table View πŸ€„ and doesn't sort data for the whole dataset
@@ -84,16 +84,16 @@ Tabular Data Viewer δΈ­ Settings, Commands, Languages, Custom Editors and Activa
8484

8585
## Settings
8686

87-
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change Tabular Data Viewer δΈ­ extension Settings:
87+
[Create User or Workspace Settings in vscode](http://code.visualstudio.com/docs/customization/userandworkspace#_creating-user-and-workspace-settings) to change Tabular Data Viewer δΈ­ extension Settings listed below. All Tabular Data Viewer Settings start with `tabular.data.` prefix, which is omottied in the Settings table below for better display in VSCode marketplace.
8888

89-
| Setting | Type | Default Value | Description |
89+
| Setting `tabular.data.` | Type | Default Value | Description |
9090
| ------- | ---- | ------------- | ----------- |
91-
| `tabular.data.createTableSchemaConfig` | boolean | `true` | Create [table `*.schema.json`](https://specs.frictionlessdata.io/table-schema/#descriptor) configuration file alongside data file when parsing CSV data. |
92-
| `tabular.data.createTableViewConfig` | boolean | `true` | Create `*.table.json` configuration file alongside data file for saving and restoring customized Table View πŸ€„ columns, sort settings, Perspective View and D3FC Charts πŸ“ŠπŸ“ˆ config options. |
93-
| `tabular.data.pageSize` | integer | `100000` | Default Data Page Size to use for incremental loading and display of large datasets. |
94-
| `tabular.data.parser.dynamicTyping` | boolean | `true` | Enable type conversions for numeric and boolean data fields when parsing CSV data. Set this option to `false` to speed up large datasets parsing and loading. |
95-
| `tabular.data.ui.theme` | string | `light` | Default data view UI theme to use for tabular data display. Current options include `light` and `dark` UI themes for `Tabulator` and `Perspective` data views. |
96-
| `tabular.data.view` | string | `Tabulator` | Default Tabular Data View type to use for displaying data. Current options include [`Tabulator`](http://tabulator.info) and [`Perspective`](https://perspective.finos.org). |
91+
| `createTableSchemaConfig` | boolean | `true` | Create [table `*.schema.json`](https://specs.frictionlessdata.io/table-schema/#descriptor) configuration file alongside data file when parsing CSV data. |
92+
| `createTableViewConfig` | boolean | `true` | Create `*.table.json` configuration file alongside data file for saving and restoring customized Table View πŸ€„ columns, sort settings, Perspective View and D3FC Charts πŸ“ŠπŸ“ˆ config options. |
93+
| `pageSize` | integer | `100000` | Default Data Page Size to use for incremental loading and display of large datasets. |
94+
| `parser.dynamicTyping` | boolean | `true` | Enable type conversions for numeric and boolean data fields when parsing CSV data. Set this option to `false` to speed up large datasets parsing and loading. |
95+
| `ui.theme` | string | `light` | Default data view UI theme to use for tabular data display. Current options include `light` and `dark` UI themes for `Tabulator` and `Perspective` data views. |
96+
| `view` | string | `Tabulator` | Default Tabular Data View type to use for displaying data. Current options include [`Tabulator`](http://tabulator.info) and [`Perspective`](https://perspective.finos.org). |
9797

9898
You can view Tabular Data Viewer δΈ­ Configuration Settings via standard vscode `Preferences -> Settings -> Extensions -> Tabular Data Viewer` Settings view or use custom `Tabular Data: View Settings` command from `View -> Command Palette...` menu prompt by typing `Tabular` in it. Hit Reload β†Ί button in open Table View πŸ€„ after you toggle Tabular Data Settings to activate your configuration changes for an open table view.
9999

0 commit comments

Comments
Β (0)