User Defined Widget Name

User Defined Widget Name


  1. The Widget Name Formatter allows users to assign meaningful, custom names to widgets across all chart and widget types in RubiSight dashboards.
  2. This helps in easy identification of widgets during interactions such as filtering, interactivity control, and configuration management.

This document explains the behavior, rules, validations, and supported functionalities of the Widget Name feature.


1. Widget Name Option Availability
  1. The Widget Name input field is available in the Formatters panel for all chart types and widgets.
  2. Users can type a custom name in the input box.

      Location:
            Formatters Panel → Widget Name (appears above Title formatter)

 

2. Default Widget Name Behavior

For any newly added widget, copied widget, or any existing widget without a saved name, the system auto-generates a default name in the following format:

            PageName + WidgetType + Index


Examples:
  1. Page1_BarChart_01
  2. Page3_PieChart_04
  3. Sales_LineChart_02

These names ensure uniqueness and easy identification.

 

3. Custom Naming Rules

✔ Allowed:
  1. User-defined names
  2. Maximum length: 100 characters
  3. Allowed characters include:
  1. Alphabets
  2. Numbers
  3. Spaces
  4. Special characters

✔ Retention:
  1. ​Custom widget names are saved and retained after:
  1. Dashboard save
  2. Page reload
  3. Switch between dashboard pages

✔ Renaming:
  1. ​Users can manually rename any widget through the formatter.

 

4. Naming Restrictions & Error Handling

The system validates:
  1. ​Blank widget names
  2. Duplicate names on the same page

When error occurs:
  1. ​Validation message is shown:
  1. “Widget name cannot be blank.”
  2. “Widget name already exists.”

If user ignores validation:

  • The widget name automatically reverts to:
    • Previously saved name
      OR
    • Default name (if new widget)

This ensures no widget ever remains unnamed or duplicated on the same page.

 

5. Behavior with Dashboard Structure Changes

A. Duplicate Page / Rename Page

  • Widget names do not change when:
    • Page is duplicated
    • Page is renamed

Reason: Widget names are treated independently from page names.

 

6. Interaction With Filters & Interactivity Controls

The following dashboard features display widget names in their widget list:

  • Filter Widget → Apply to Widgets
  • Interactivity Control
  • Widget List (where applicable)

Behavior:

  • These lists always show the current widget names.
  • If a widget name is updated, the UI updates immediately in all related lists.

This ensures clarity and prevents confusion while applying interactions or filters.

 

7. Behavior With Deleted Widgets

  • A widget name previously used can be reused after that widget is deleted.
  • Example: If Sales_Bar_01 widget is deleted, the name can now be assigned to another widget.