LightweightWhiteboard:Commands and Settings

This page lists everything the extension adds to VS Code, taken from its package.json, and the keys that work on the board.

Commands

Command Palette	Command ID	What it does
Whiteboard: New Whiteboard	vscWhiteboard.new	Opens a new, unsaved board named whiteboard-<n>.whiteboard. See Getting Started.

The extension adds no menu entries. To open a PNG in the board, use the built-in VS Code command View: Reopen Editor With... or Open With... in the Explorer context menu.

Editors and file types

Editor	View type	Files	Priority
Whiteboard	vscWhiteboard.editor	*.whiteboard	Default. These files open in the board automatically.
Whiteboard (edit PNG)	vscWhiteboard.pngEditor	*.png	Option. Only used when you choose it with Reopen Editor With....

The extension adds no languages. To open all PNG files in the board by default, you can use the VS Code setting workbench.editorAssociations:

"workbench.editorAssociations": {
    "*.png": "vscWhiteboard.pngEditor"
}

Settings

All settings are in the section Whiteboard of the settings editor.

Setting	Type	Default	Values	What it does
vscWhiteboard.customColors	list of strings	[]	hex colors like #1e90ff	Your saved colors from the color dialog (My colors). Shared by all boards. See Colors.
vscWhiteboard.defaultWidth	integer	1920	100 to 8000	Width in pixels of new boards.
vscWhiteboard.defaultHeight	integer	1080	100 to 8000	Height in pixels of new boards.

• The board writes vscWhiteboard.customColors to your user settings when you save or remove a color in the color dialog. Changes to the setting reach all open boards at once.
• defaultWidth and defaultHeight are read when a board is opened. They only apply to boards without an image: new boards, reverted new boards and files that could not be read. Existing boards keep the size of their image.
• The ranges are part of the setting definition. The settings editor warns about values outside the range. The board itself does not check them.

Example for settings.json:

"vscWhiteboard.defaultWidth": 1280,
"vscWhiteboard.defaultHeight": 720,
"vscWhiteboard.customColors": ["#1e90ff", "#ff8800"]

Keyboard shortcuts

The extension adds no VS Code key bindings. The following keys only work while the board has the focus and you are not typing in a text field.

Tools

Key	Tool
P	Pen
E	Eraser
L	Line
A	Arrow
R	Rectangle
O	Ellipse
T	Triangle
F	Fill bucket
I	Pick color

Other keys

Key	Action
[ / ]	Smaller / larger size
Shift (while drawing a shape)	Square, circle, equilateral triangle, lines in 45° steps
Shift (while resizing an image)	Ignore the aspect ratio
Esc	Cancel the stroke or shape you are drawing, or discard a floating image
Delete, Backspace	Discard a floating image
Enter	Place a floating image
Space + drag	Pan the view
Ctrl + mouse wheel	Zoom at the pointer
Ctrl+V	Paste an image from the clipboard

Undo, redo and save

Undo, redo, save and revert are normal VS Code commands and use your VS Code key bindings, for example Ctrl+Z for undo and Ctrl+S for save.