Navigate to Script Help Page

This section explains how to access the Script Help Page under within the Designer module.

BDB offers a scripting mechanism in the Designer plugin to help users experience the next level of customization in dashboard creation. "Script Help" in the Designer plugin provides a streamlined way to find code examples and snippets. It's designed to help you quickly write both component- and dashboard-level scripts, making the process of customizing your dashboards more efficient.

Prerequisites:

  • Basic familiarity with the Component Variables & Script panel.

  • A dashboard canvas open (with at least one component selected for component-level scripting).

Open the Script Editor

  1. Open the Dashboard canvas.

  2. Click Component Variables & Script (right-side panel).

Get help while scripting

You have two ways to access help:

Option 1 — In-editor suggestions (Ctrl + Space)

  • Place the cursor in the script editor and press Ctrl+Space.

  • You’ll see context-aware suggestions (e.g., variables, events, functions) based on:

    • Scope: Component vs. Dashboard.

    • Selection: The component you have selected.

    • Bindings: Available variables, connections, and properties.

Use it for: Quick autocompletion, valid property names, and event handler scaffolds.

Option 2 — Visit the Script Help library

  • Click the "visit help section" in the Script Window.

  • You’ll be redirected to the Script Help page with two tabs:

    • Scripting Help: Predefined, common snippets (e.g., onClick → set filter, refresh chart, bind variable to title).

    • Advanced Help: More complex patterns (e.g., conditional logic, cross-component coordination, parameter passing, refresh chains).