Web SDK documentation
  1. Interfaces
  2. WidgetControlSettings

File

global-context/integration/widget-controls/widget-controls-factory.ts

Description

Hierarchical configuration for widget control visibility and behavior across different contexts.

This interface defines control settings organized by:

  • Display mode (dashboard/config/viewAndConfig)
  • Refresh option (live/history)
  • View context (inline/configuration)

Each level can specify which controls to show/hide and their default link states to the global context. The structure mirrors how widgets are rendered in different scenarios.

Example :
const settings: WidgetControlSettings = {
  dashboard: {
    live: {
      inline: { showRefresh: true, showRefreshInterval: false }
    }
  },
  defaultLinks: {
    dashboard: {
      live: { dateTimeContext: true, aggregation: true }
    }
  }
};

Index

Properties

Properties

config
config: literal type
Type : literal type
Optional
dashboard
dashboard: literal type
Type : literal type
Optional
defaultLinks
defaultLinks: literal type
Type : literal type
Optional

Defines which widget config properties should be linked to global context by default. When a property is linked (true), changes to the global context will automatically update the widget's corresponding configuration value.
viewAndConfig
viewAndConfig: literal type
Type : literal type
Optional

results matching ""

    No results matching ""