Class Events

The API UI Class. An instance is available via the global API.v1.events variable.

Index

Methods

onActivate onDetail onFilter onRefresh

Methods

onActivate

onActivate(eventFunction: EventFunction): void
Parameters
- eventFunction: EventFunction
  function to execute when tab has been clicked when widget is in tab
Returns void
Example
```
API.v1.events.onActivate(function() {
  console.info('I became active');
})
```

onDetail

onDetail(eventFunction: EventFunction): void
Parameters
- eventFunction: EventFunction
  function to execute when detail changed
Returns void
Example
```
API.v1.events.onDetail(function(detailInfo) {
  console.info('Im a detail widget: ', detailInfo);
  doDetails(detailInfo);
})
```

onFilter

onFilter(eventFunction: EventFunction): void

Parameters

eventFunction: EventFunction
function to execute when filter changed

Returns void

Example

API.v1.events.onFilter(function(filter) {
  console.info('I should filter my widget plugin data...', filter);
  doMyFilter(filter);
})

onRefresh

onRefresh(eventFunction: EventFunction): void
Parameters
- eventFunction: EventFunction
  function to execute when refreshing
Returns void
Example
```
API.v1.events.onRefresh(function() {
  console.info('I should refresh my widget plugin data...');
  refreshMyData();
})
```