Web SDK documentation
  1. Components
  2. GlobalContextConnectorComponent

File

global-context/integration/global-context-connector/global-context-connector.component.ts

Metadata

selector c8y-global-context-connector
standalone true
imports ContextControlsComponent LinkButtonsComponent
template 
@if (hasActiveControls()) {
  <c8y-link-buttons
    [dashboardChild]="dashboardChild()"
    [isLinked]="isLinked()"
    [controls]="controls()"
    [config]="config()"
    (toggle)="onLinkToggle($event)"
  ></c8y-link-buttons>

  @if (!isLinked()) {
    <c8y-context-controls
      [controls]="controls()"
      displayMode="dashboard"
      [config]="config()"
      [isLoading]="isLoading()"
      (configChange)="onLocalChange($event)"
      (refresh)="onLocalRefresh()"
    ></c8y-context-controls>
  }
}

Index

Properties
Methods
Inputs
Outputs

Constructor

constructor()

Inputs

config
Type : GlobalContextState
Required :  true
controls
Type : PresetName | PresetDefinition
Default value : PRESET_NAME.DEFAULT
dashboardChild
Type : DashboardChildComponent
Required :  true
emitRefresh
Type : boolean
Default value : true

When false, refresh events are not emitted as configChange - only user-initiated state changes
isLoading
Type : boolean
Default value : false
linked
Type : boolean | undefined
Default value : undefined

Outputs

configChange
Type : { context: GlobalContextState; diff: GlobalContextState }
linkedChange
Type : boolean
refresh
Type : void

Methods

onLinkToggle
onLinkToggle(linked: boolean)
Parameters :
Name Type Optional
linked boolean No
Returns : void
onLocalChange
onLocalChange(event: literal type)
Parameters :
Name Type Optional
event literal type No
Returns : void
onLocalRefresh
onLocalRefresh()
Returns : void

Properties

hasActiveControls
Type : unknown
Default value : computed(() => { const controlsInput = this.controls(); if (!controlsInput) { return true; } const presetDef = typeof controlsInput === 'string' ? CONTROL_PRESETS[controlsInput] : controlsInput; const dashboardControls = presetDef?.[GLOBAL_CONTEXT_DISPLAY_MODE.DASHBOARD]; if (!dashboardControls) { return true; } const refreshOption = this.config()?.refreshOption || REFRESH_OPTION.LIVE; return applyModeConstraints(dashboardControls, refreshOption).length > 0; })
isLinked
Type : unknown
Default value : signal(true)

results matching ""

    No results matching ""