Create a portal
1. Log in to the ClearBlade Platform and select the system you wish to link to a portal.
2. Navigate to the Portals button on the sidebar or menu of the developers console.
3. Create a new portal by clicking + Add.
4. Enter your portal’s description.
...
Assign roles
Click the gear icon next to your new portal and select Edit Roles to permit users to access and edit the portal.
...
Welcome to your portal!
...
Delete a portal
1. Select Settings.
...
2. Click Delete Portal. Confirm the deletion when prompted.
...
Datasources
1. Click Add Datasource+ in the side editor.
2. Complete the datasource information
...
in the popup window. In this case, use a ClearBlade collection you created previously.
3. Click Apply, and the datasource and its last update will appear in the side editor. It can also be used in a widget under Dynamic.
...
Panes
Create a pane
1. Click the + button on the side editor’s top toolbar
...
. A dropdown will appear.
2. Choose New Pane.
...
A pane will appear in the portal.
Edit pane
1. Click the wrench icon of the pane you wish to edit.
...
Pane fields
Title
The pane’s optional title
...
Whether or not the pane will contain tabs
Theme
The theme’s pane’s theme type for the pane (primary or secondary)
Pane ID
...
Click the resize handle on the pane’s bottom right corner and drag it to the desired shape.
...
Delete pane
1. Click the trashcan button on the pane you wish to delete.
2. Confirm deletion when prompted.
...
Widget
Click here for a tutorial on each widget.
1. Add a pane before adding a widget.
2. Click the + button on the pane header toolbar.
3. Choose a widget type and edit it in this window.
4. Click Apply to save the changes.
...
Edit/delete widget
Hover over the widget and click the wrench icon to edit. Click the trash can icon to delete.
...
The menu title defaults to the portal’s name but can be configured like any widget. ..
Add menu widgets
Click the plus icon on the header bar’s left-hand side.
...
Edit menu widgets
Widgets can be edited in the same way like they are inside a normal pane.
Header pane
Add a widget to the header
Click the + button on the side editor’s top toolbar of the side editor. A dropdown will appear.
...
Hover over Pages on the side editor and click the +.
...
Fill in the page’s name of the page and click Apply.
...
Edit/delete page
...
Adding children to the page
1. Click the plus button of the page you wish to add a child page.
...
2. Add name and parameters.
...
CB_PORTAL.getPathParams() // will return {"state": "TX", "city": "Austin"} if the current path is "/states/TX/city/Austin"
Example use case:
1. The current page changes, so the portal should display data
...
relevant to the URL parameters.
2. The portal must load the correct state on initial startup when the URL is /states/TX/city/Austin.
Edit/delete page
Click the pencil icon of the page you wish to edit.
Click the trash icon of the page you wish to delete. Confirm deletion when prompted.
...
Modals
1. Hover over Modals on the side editor and click the +.
2. Give it a name and size, and choose to make it draggable and close on click outside. Draggable: allows the modal to drag around the portal. Close on click outside: allows modals to close when the user clicks away from them. You cannot select close on click if you make the modal draggable. There will be tips in the modal as a default. You can hover over these and edit the widget by clicking the wrench.
3. You can add more widgets by clicking + Add Widget next to the modal.
4. To edit or delete the modal, hover over the name in the side editor and click the pencil or trash can, respectively.
...
Internal resources
Internal resources can be added in the toolbar on the right of the portal.
...
Click Add Internal Resource, and a New File modal will appear. Give your file a unique name, choose whether it is a JS or CSS file, and type in the code. There is an option to test before saving the changes.
Type | Parser | Appearance |
|---|---|---|
JS |  |  |
CSS |  |  |
Import file
Click Import Files and choose the file(s) from your device.
...
External resources can be added in the toolbar on the right of the portal.
...
In the example, a A CSS URL from Font Awesome Icons will be used in the example. The icons can be found here.
...
Copy the URL (https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.9.0/css/all.css) and add it to the box that appears after clicking Add Resource +.
...
There is a checkbox option to do block widget render if there is an import error.
...
3. The parser will open a window where you can customize your widget data. The changes you make When you click Test, your changes will appear on the parser’s right side of the parser when you click Test.
4. Click Apply to save the changes.
...
This guide assumes that panes and widgets have already been added to your portal.
1. Select the screen size you’d like to change the layout for by clicking the toolbar’s section at the top of the screen.
2. Adjust the layout by resizing your panes and widgets.
...
Theme editor
Macro
Choose between a standard or night base -based theme.
Choose different color themes using a palette.
Change the graph element colors of the graph elements.
...
Micro
Change the color palette by portal element.
...