Overview

Looking for something in particular?

What is a component?

Squirrel components are essential building blocks for any project you create. They include Charts and Tables for displaying data, Controls for managing data movement and functionality, as well as Shapes and Media for designing and building a user interface.

Adding a component

To open the Component Library, click the icon. This action will reveal the 'Add Component' library, showcasing various sub-sections for each component type. At the top of the library, you'll find a search bar and buttons to switch the library's view: Grid View (default) or List View.

Select the desired component and move the cursor over the canvas area. There are a few options for placing a component on the canvas:

1. One-click placement

2. Drawing component

1. Double-click component

Grouping Components

Components can be grouped on the canvas. When grouped, these components can be moved together on the canvas, as a single layer in the Component Tree.

Components can be grouped in a few ways:

1. Ctrl + G

2. Right-click menu

3. Arrange Menu

Arranging Components

Components can be arranged on the canvas based on their positions and size. When multiple components are selected, the arrange menu will be enabled.

View components in action

When on the canvas, components have no interaction and serve only as a means of styling and layout. Components can be "tested" and viewed in action within the Debug and Preview menus.

Debug

Debug acts as a means to "test" a project. When in this mode, components can be interacted with on the canvas, and display the set styling for each of their states. In addition to this, the spreadsheet is still visible. allowing you to see what is happening in the spreadsheet while interacting with the components.

Preview

Preview mode acts as a means of viewing the project as it will be seen in the browser before publishing. When in this mode, the spreadsheet cannot be viewed, but the components can be interacted with.

What is a function?

Squirrel functions are "invisible" interactions that work behind the scenes. From highly dynamic movement of data with the Data Mover and MegaQuery functions, to connections between parent and child with the Tableau or External Parameters.

Adding a function

Adding a function is very similar to adding a function to the canvas, minus the drag-and-drop interaction with the canvas itself.

To access the Functions panel and Functions Library, select the icon on the Left-Side Menu. The Functions panel will expand that contains a search bar and an 'Add a Function' button.

{{pending image}}

Functions can be added by hovering over the desired Function and selecting the icon to add it to the Functions panel.

What is a connection?

Connections take your Squirrel projects to the next level. Power your projects with externalized spreadsheets from sources like Google Sheets or Excel Online.

Adding a connection

Adding a connection is very similar to adding a function.

To access the Connections library, select the icon on the Left-Side Menu. A small side interface will expand, containing a search bar and an 'Add a Connection' button.

Connections can then be added by hovering over the desired one and clicking the icon that appears. Any added connection will then appear on the list to the left side of the library.