Web SDK documentation
  1. Injectables
  2. AlarmEventSelectorService

File

alarm-event-selector/alarm-event-selector.service.ts

Index

Methods

Constructor

constructor(alarmService: AlarmService, eventsService: EventService, color: ColorService)
Parameters :
Name Type Optional
alarmService AlarmService No
eventsService EventService No
color ColorService No

Methods

Async createItem
createItem(timelineType, item: IAlarm)
Parameters :
Name Type Optional
timelineType No
item IAlarm No
Returns : Promise<AlarmDetails>
Async createItem
createItem(timelineType, item: IEvent)
Parameters :
Name Type Optional
timelineType No
item IEvent No
Returns : Promise<EventDetails>
Async createItem
createItem(timelineType: TimelineType, item: IAlarm | IEvent)
Parameters :
Name Type Optional
timelineType TimelineType No
item IAlarm | IEvent No
Returns : Promise<any>
Async getAlarmsOrEvents
getAlarmsOrEvents(parentReference: IIdentified, timelineType: TimelineType)

This method returns the items of the asset based on the timeline type.

Parameters :
Name Type Optional Description
parentReference IIdentified No

The parent reference.
timelineType TimelineType No

The timeline type.
Returns : Promise<AlarmOrEvent[]>

The alarms or events of the asset.
Async getItems
getItems(timelineType: TimelineType)

This method returns all alarms or events of the platform based on the timeline type

Parameters :
Name Type Optional Description
timelineType TimelineType No

The timeline type.
Returns : Promise<AlarmOrEvent[]>

The alarms or events of the asset.
Async getUniqueAlarmsOnly
getUniqueAlarmsOnly(data: IAlarm[])
Parameters :
Name Type Optional
data IAlarm[] No
Returns : Promise<AlarmDetails[]>
Async getUniqueEventsOnly
getUniqueEventsOnly(data: IEvent[])
Parameters :
Name Type Optional
data IEvent[] No
Returns : Promise<EventDetails[]>
timelineTypeTexts
timelineTypeTexts(timelineType: TimelineType)

This method returns the texts for the timeline type.

Parameters :
Name Type Optional Description
timelineType TimelineType No

The timeline type.
Returns : TimelineTypeTexts

The texts for the timeline type.

results matching ""

    No results matching ""