Documentation
Documentation
Start typing to search…

View Dashboard important components and Context

  1. Dashboard: A Dashboard is for integrating and coordinating visualization with widgets, context management, and data processing. Key features of dashboard include:

    • Context Builders: Configure context listeners for managing data and interactions.
    • Handlers: Process incoming context.
    • Nested Dashboards: Enable dashboards to include other dashboards as widgets.
    • Widget Context Management: Each widget can emit, listen, and process context using its internal logic.
    • Data Source Integration: Widgets are connected to Database for real-time data retrieval and processing.

  2. Widgets: Visualization Components:
    Visualization Types:

    • Chart: Retrieves and displays time-series data between a selected Start Time and End Time, based on the Time Bar Widget.
    • Pie Chart: Represents proportional data from selected time intervals or categories.
    • Gauge: Displays live measurements.
    • Label: Shows text.
    • Value Widget: Retrieves and displays the Current Value/Historical value.
      Interaction with Data Sources:
      • Widgets can connect to the Database, retrieving data in real-time or historical data for visualizations. Example:
        • A Chart fetches historical data using a Start Time and End Time provided by the Time Bar Widget.
        • Value Widget displays the current value/historical value of a variable or equipment property based on configuration

  3. Context Builders – In the dashboard properties this is a section
    Configure Context Listeners, which include:

    • Widget: Represents a specific visual component.
    • Context Key: A unique identifier for context.
    • Handling Dropdown: Defines context sources:
      • External: Sends context to external dashboards.
      • Local: Sends context within the same dashboard.
      • Both: Sends context from both sources.

  4. Context Mapper– In the dashboard properties this is a section

    • Facilitate the processing of incoming context from other dashboards or from widgets also.
    • Configure Handlers, which include:
      • Key: Identifies context to process.
      • Class (Data Source): Represents the source for context handling.
      • Target Reference: Specifies the target widget, this is where the context will be used.

  5. Widget Level Context Management:

    • Unique Context Key::
      • Each widget must have a unique context key for precise identification.
    • Widget Context Emission::
      • Widgets can emit their own context during runtime or on dashboard initialization.
    • Widget Context Listening and Handling:
      • Widgets dynamically process incoming context using internal logic to:
      • Update visualizations (e.g., adjust time ranges on a Chart).
      • Perform actions (e.g., update parameters on a Gauge or Label).

  6. Global Context:

    • Send Global Context:
      • Broadcast context globally for cross-dashboard interactions.
    • Listen Global Context:
      • Subscribe to global context for system-wide event handling.

  7. Nested Dashboards:

    • Nested dashboards can:
      • Emit Context: Propagate context to parent dashboards or other widgets.
      • Listen to Context: Subscribe to local, external, or global context.

  8. Inter-Widget Context Listening:

    • Avoid Circular Reference:
      • Maintain a hierarchical structure to prevent loops between widgets or dashboards.
    • Widgets Interact Dynamically:
      • For example, a Select Widget sends Source and selected Process path as a context:
        • A Label widget show the process path selected in the Select Widget when Label Widget Listen to Context (of Select widget).

Updated 2 months ago