Web SDK documentation
  1. Components
  2. AlarmListWidgetComponent

File

widgets/implementations/alarms/alarm-list-widget-view/alarm-list-widget.component.ts

Implements

OnInit OnDestroy DynamicComponent

Metadata

providers AlarmRealtimeService AlarmWithChildrenRealtimeService
selector c8y-alarm-list-widget
imports AlarmsListComponent AsyncPipe LocalControlsComponent GlobalContextConnectorComponent
templateUrl ./alarm-list-widget.component.html

Index

Properties
Methods
Inputs

Inputs

config
Type : AlarmListWidgetConfig

Methods

getDashboardChild
getDashboardChild()
Returns : DashboardChildComponent
ngOnDestroy
ngOnDestroy()
Returns : void
Async ngOnInit
ngOnInit()
Returns : Promise<void>
onContextChange
onContextChange(event: literal type)
Parameters :
Name Type Optional
event literal type No
Returns : void
onRefresh
onRefresh()
Returns : void
onScrollingStateChange
onScrollingStateChange(isScrolling: boolean)
Parameters :
Name Type Optional
isScrolling boolean No
Returns : void

Properties

alarms$
Type : BehaviorSubject<IResultList | null>
Default value : new BehaviorSubject(null)
alerts
Type : DynamicComponentAlertAggregator
Readonly CONTEXT_FEATURE
Type : unknown
Default value : CONTEXT_FEATURE
contextConfig
Type : unknown
Default value : signal<GlobalContextState>({})
displayMode
Type : unknown
Default value : signal<DisplayMode>(GLOBAL_CONTEXT_DISPLAY_MODE.DASHBOARD)
Readonly GLOBAL_CONTEXT_DISPLAY_MODE
Type : unknown
Default value : GLOBAL_CONTEXT_DISPLAY_MODE
hasPermissions
Type : unknown
Default value : true
isLinkedToGlobal
Type : unknown
Default value : signal<boolean | undefined>(undefined)
isLoading$
Type : BehaviorSubject<boolean>
Default value : new BehaviorSubject(true)
Readonly PRESET_NAME
Type : unknown
Default value : PRESET_NAME
Readonly REFRESH_OPTION
Type : unknown
Default value : REFRESH_OPTION
widgetControls
Type : unknown
Default value : signal<PresetName>(PRESET_NAME.ALARM_LIST) 
@if (displayMode() === GLOBAL_CONTEXT_DISPLAY_MODE.DASHBOARD) {
  <c8y-global-context-connector
    [controls]="widgetControls()"
    [config]="contextConfig()"
    [isLoading]="isLoading$ | async"
    [dashboardChild]="getDashboardChild()"
    [linked]="isLinkedToGlobal()"
    (configChange)="onContextChange($event)"
    (refresh)="onRefresh()"
  ></c8y-global-context-connector>
} @else {
  <c8y-local-controls
    [controls]="widgetControls()"
    [displayMode]="displayMode()"
    [config]="contextConfig()"
    [isLoading]="isLoading$ | async"
    (configChange)="onContextChange($event)"
    (refresh)="onRefresh()"
  ></c8y-local-controls>
}

<c8y-alarms-list
  #list
  [alarms]="alarms$ | async"
  [navigationOptions]="{
    alwaysNavigateToAllAlarms: !config.device,
    allowNavigationToAlarmsView: true,
    includeClearedQueryParams: true,
    queryParamsHandling: ''
  }"
  [isInitialLoading]="isLoading$ | async"
  [hasPermissions]="hasPermissions"
  (onScrollingStateChange)="onScrollingStateChange($event)"
></c8y-alarms-list>

results matching ""

    No results matching ""