Web SDK documentation
  1. Components
  2. GlobalContextWidgetConfigComponent

File

global-context/core/global-context-widget-config.component.ts

Description

Widget configuration component for time context settings.

Allows widgets to either sync with dashboard-level time settings (dashboard mode) or use independent time controls (widget mode). When in widget mode, displays additional configuration controls for time range, aggregation, and refresh settings.

Implements

OnInit

Metadata

changeDetection ChangeDetectionStrategy.OnPush
selector c8y-global-context-widget-config
standalone true
imports ReactiveFormsModule ConfigContextSelectorComponent GlobalContextConfigComponent C8yTranslatePipe PopoverModule
template 
<form [formGroup]="form">
  <fieldset class="c8y-fieldset">
    <legend>
      {{ 'Time context' | translate }}
      <button
        class="btn-help btn-help--sm"
        [attr.aria-label]="'Help' | translate"
        [popover]="
          'Sync with dashboard settings or set independent time controls for this widget.'
            | translate
        "
        placement="right"
        triggers="focus"
        container="body"
        type="button"
        [adaptivePosition]="true"
      ></button>
    </legend>
    <c8y-config-context-selector formControlName="displayMode"></c8y-config-context-selector>
  </fieldset>
</form>

@if (configInput()?.displayMode !== GLOBAL_CONTEXT_DISPLAY_MODE.DASHBOARD) {
  <fieldset class="c8y-fieldset p-l-0 p-r-0 p-t-16">
    <legend class="m-l-16">{{ 'Widget time context' | translate }}</legend>
    <c8y-global-context-config
      [config]="_latestConfig()"
      [widgetControls]="widgetControlsInput()"
      [isLoading]="isLoadingInput()"
      [liveSnapshot]="liveSnapshot"
      [historySnapshot]="historySnapshot"
      (refresh)="refresh.emit()"
      (globalContextChange)="onGlobalContextChange($event)"
    ></c8y-global-context-config>
  </fieldset>
}

Index

Properties
Methods
Inputs
Outputs
Accessors

Constructor

constructor()

Inputs

configInput
Type : GlobalContextState | null
Required :  true
Default value : { alias: 'config' }
isLoadingInput
Default value : false, { alias: 'isLoading' }
widgetControlsInput
Type : WidgetControls
Required :  true
Default value : { alias: 'widgetControls' }

Outputs

displayModeChange
Type : GlobalContextDisplayMode
globalContextChange
Type : GlobalContextState
refresh
Type : void

Methods

ngOnInit
ngOnInit()
Returns : void
onGlobalContextChange
onGlobalContextChange(newConfig: GlobalContextState)
Parameters :
Name Type Optional
newConfig GlobalContextState No
Returns : void

Properties

Readonly displayModeSig
Type : unknown
Default value : signal<GlobalContextDisplayMode>(GLOBAL_CONTEXT_DISPLAY_MODE.DASHBOARD)
Protected form
Type : FormGroup
Readonly GLOBAL_CONTEXT_DISPLAY_MODE
Type : unknown
Default value : GLOBAL_CONTEXT_DISPLAY_MODE

Accessors

liveSnapshot
getliveSnapshot()
historySnapshot
gethistorySnapshot()

results matching ""

    No results matching ""