Powered by Wijmo, this extension provides read-only viewers for CSV files and Excel spreadsheets within the current Visual Studio Code workspace.
This extension requires Visual Studio Code 1.46.0 or greater.
Version 3.0 includes some major improvements:
- The extension no longer opens a web server on localhost, eliminating Windows firewall alerts once and for all.
- Previews are now persisted when a webview is hidden, preserving scroll position and selected cells without reinitializing the webview.
- Previews are now automatically restored when Visual Studio Code restarts, including sort/filter criteria and column layouts.
Please read this section, which describes common customizations to the default configuration for column separators and other settings that affect CSV files.
For files with a .csv, .tsv, or .tab extension, use the explorer context menu or editor title menu to invoke the
Open Preview command. The contents of the file will be displayed in a FlexGrid control, which supports sorting and filtering via its column headers.
For .tsv and .tab files, a tab delimiter is assumed. For plain text files with different extensions, open the file in an editor and execute the
CSV: Open Preview command from the command palette.
For files with an .xlsx or .xlsm extension, use the explorer context menu or editor title menu to invoke the
Open Preview command. The contents of the file will be displayed in a FlexSheet control. If multiple sheets are present, use the controls at the bottom of the view for navigation.
The extension adapts its display to the current Visual Studio Code theme. For best results, choose a theme with opaque selection background colors.
The extension automatically stores user customizations on a per-file, per-workspace basis. For CSV files, this includes column widths, sort/filter criteria, data types, format strings, and scroll bar positions. For Excel files, this includes the selected sheet index, sort/filter criteria, and scroll bar positions associated with that sheet only. If the column structure of a CSV file changes, any persistent data is ignored for that file.
To discard persistent data for a CSV or Excel file, execute the command
CSV: Clear Preview State. The preview will be refreshed automatically.
By default, numeric formatting is always enabled for CSV files, and the extension will examine the first row of data to determine which columns are numeric. The setting
csv-preview.numberFormat specifies a .NET-style format string that controls the display type and significant digits for all numeric columns. This setting defaults to
g2, which specifies two significant digits and does not display a thousands separator.
csv-preview.formatValues controls how numeric formatting is applied:
|All numeric values are formatted according to the
csv-preview.numberFormat setting. This is the default.
|All values are treated as strings, and no numeric formatting occurs.
|Numeric values are formatted, but only if they are not enclosed in quotes. If a column contains a mixture of quoted and unquoted values, the value in the first data row takes precedence.
Since data types and format strings are persisted along with other column properties, you may need to run the
CSV: Clear Preview State command to see the effects of changing the
To change the default configuration settings for the Excel Viewer extension, edit the user or workspace settings as described here. The available settings are as follows:
||Specifies the separator used in a CSV file.
||Specifies the optional character used to surround individual values in a CSV file.
||Specifies whether the first row in a CSV file represents column headers.
||Specifies whether column headers in CSV files are capitalized.
||Specifies whether columns are automatically resized to fit the data for CSV files.
||Specifies whether to display line numbers for CSV files.
||Specifies the character used to mark comment lines in CSV files.
||Specifies whether lines that begin with the comment character should be omitted from the CSV preview.
||Specifies whether to format numeric values in CSV files, or to treat them as strings.
||Specifies a .NET-style format string used to format numeric columns in CSV files.
||Specifies whether text piped to stdin is automatically opened as a CSV preview.
Any open CSV/Excel previews will automatically update to reflect the modified settings, except where noted in the previous section.
Regular Expression Settings
The following configuration settings are used within regular expressions when processing CSV files. Therefore, you need to escape any special regular expression characters with a backslash in order to achieve the desired result.
For example, to override the default separator character (comma) with a dollar sign, you would enter the following in the settings editor:
However, if you are editing the
settings.json file directly, an extra backslash is required:
Likewise, to use a vertical bar as the separator character:
However, if you want to use the tab character as a separator, only one backslash is needed:
You can also specify multiple separator characters by using a regular expression character set. For example, to recognize a comma OR a semicolon as a separator, enclose both characters in square brackets:
Likewise, to use both % and @ as comment symbols (instead of #), do this: