Scripting API / dashboard/dashitems/DashboardItemListener

dashboard/dashitems/DashboardItemListener

Modules

Module	Description
External	-

Classes

DashboardItemListener

Extends

• GSEventListener<DashboardItemEventOptions, DashboardItemEventType>

Methods

addEventListener()

addEventListener(eventType, handler): ScriptEventSubscription

Binds the given function to an event fired by one or more sub-inspections. Returns a GUID that can be used to remove the added event

Parameters

Parameter	Type	Description
eventType	DashboardItemEventType	Type of event to bind to (e.g. 'afterStart'). Valid types are determined by the EventType generic.
handler	EventHandler<DashboardItemEventOptions>	-

Returns

ScriptEventSubscription

Inherited from

GSEventListener.addEventListener

Type Aliases

DashboardItemEventOptions

DashboardItemEventOptions = object

Properties

Property	Type
itemType	DashboardItemType
scriptId	string