Skip to end of metadata
Go to start of metadata

The Sisense Pulse API exposes several objects and Pulse events that allow you to customize how your Pulse tiles are displayed in the Sisense Pulse page and when. 

 The Sisense Pulse API includes two objects, Alerts and AlertsBoard. The AlertsBoard contains Alerts that are displayed in the Sisense Pulse page. Each object has events that you can leverage to modify how Pulse tiles are displayed.

To add custom JavaScript to a tile:

  1. Click the Dashboard menu  button in the top-right corner of the Dashboard and select Edit Script .

  2. In the JavaScript editor that opens, you can add and edit your JavaScript code.

  3. Click Save and refresh Pulse.

AlertsBoard

The AlertsBoard object contains all the alert objects on a Pulse page and triggers events related to the Alerts.

Properties

 

Property

Type

Description

tiles

[ Alert ]

List of alerts on the page.

 

Events

 

Event name

Event Arguments

Description

beforetiletooltipconfig

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Tooltip name.

tooltipConfig : {

  scope,

  template,

  templateUrl

}

tooltipUi : {

  css,

  placement: {

      place,

      anchor

  },

  radial,

  showDuration,

  initialShowDelay,

  betweenShowDelay

}

Fired for the relevant alert before a tooltip is created. You can use this event to configure an alert's tooltip appearance.

Available tooltip names:

  • headerTooltip

  • contentTooltip

  • offTippets

beforetiletooltip

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Tooltip name.

tooltipPos : {

  x,

  y

}

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before showing its tooltip.

Available tooltip names:

  • headerTooltip

  • contentTooltip

  • offTipper

beforetilemenu

alert: Source alert that triggers the event.

element : Source element that triggers the event.

items : Array of items to be displayed.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before showing its configuration menu.

tiletabselected

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Name of the opened tab.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert after its tab is selected.

beforetilequery

alert: Source alert that triggers the event.

element : Source element that triggers the event.

request : Request object.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before sending a query for data to the server.

aftertilequery

alert: Source alert that triggers the event.

element : Source element that triggers the event.

response : Response object.

Fired for the relevant alert after a query response received from the server.

beforetilerender

alert: Source alert that triggers the event.

element : Source element that triggers the event.

Fired for the relevant alert before an alert tile is rendered.

aftertilerender

alert: Source alert that triggers the event.

element : Source element that triggers the event.

Fired for the relevant alert after an alert tile is rendered.

loaded

 

Fired after all alerts are loaded and rendered.

 

Alert

Contains an alert’s properties and trigger life cycle events.

Properties

 

Property

Type

Description

name

string

Name of the alert.

type

string

Type of the alert ('build', 'kpi', and etc.).

category

string

Category of the alert ('system', 'kpi', and etc.).

action

object

Describes notification options.

enabled

boolean

Defines if an alert enabled or disabled.

 

Events

 

Event name

Event Arguments

Description

beforetooltipconfig

element : Source element that triggers the event.

name : Tooltip name.

tooltipConfig : {

  scope,

  template,

  templateUrl

}

tooltipUi : {

  css,

  placement: {

      place,

      anchor

  },

  radial,

  showDuration,

  initialShowDelay,

  betweenShowDelay

}

Fired before a tooltip is created. You can use this event to configure an alert's tooltip appearance.

beforetooltip

element : Source element that triggers the event.

name : Tooltip name.

tooltipPos : {

  x,

  y

}

cancel : Prevent a tooltip from being displayed.

Fired before displaying a tooltip.

beforemenu

element : Source element that triggers the event.

items : Array of items to be displayed.

cancel : Prevent a menu from being displayed.

Fired before showing an alert’s configuration menu.

tabselected

element : Source element that triggers the event.

name : Name of the opened tab.

cancel : Prevent a tab from being displayed.

Fired after an alert tab selected.

beforequery

element : Source element that triggers the event.

request : Request object.

cancel : Prevent a query from being sent.

Fired before sending a query for data to the server.

afterquery

element : Source element that triggers the event.

response : Response object.

Fired after a query response is received from the server.

beforerender

element : Source element that triggers the event.

Fired before an alert tile is rendered.

afterrender

element : Source element that triggers the event.

Fired after an alert tile is rendered.

 

The Sisense Pulse API exposes several objects and Pulse events that allow you to customize how your Pulse tiles are displayed in the Sisense Pulse page and when.


The Sisense Pulse API includes two objects, Alerts and AlertsBoard. The AlertsBoard contains Alerts that are displayed in the Sisense Pulse page. Each object has events that you can leverage to modify how Pulse tiles are displayed.

To add custom JavaScript to a tile:

  1. Click the Dashboard menu  button in the top-right corner of the Dashboard and select Edit Script .

  2. In the JavaScript editor that opens, you can add and edit your JavaScript code.

  3. Click Save and refresh Pulse.


AlertsBoard

The AlertsBoard object contains all the alert objects on a Pulse page and triggers events related to the Alerts.


Properties


 

Property

Type

Description

tiles

[ Alert ]

List of alerts on the page.

 

Events

 

Event name

Event Arguments

Description

beforetiletooltipconfig

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Tooltip name.

tooltipConfig : {

  scope,

  template,

  templateUrl

}

tooltipUi : {

  css,

  placement: {

      place,

      anchor

  },

  radial,

  showDuration,

  initialShowDelay,

  betweenShowDelay

}

Fired for the relevant alert before a tooltip is created. You can use this event to configure an alert's tooltip appearance.

Available tooltip names:

  • headerTooltip

  • contentTooltip

  • offTippets

beforetiletooltip

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Tooltip name.

tooltipPos : {

  x,

  y

}

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before showing its tooltip.

Available tooltip names:

  • headerTooltip

  • contentTooltip

  • offTipper

beforetilemenu

alert: Source alert that triggers the event.

element : Source element that triggers the event.

items : Array of items to be displayed.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before showing its configuration menu.

tiletabselected

alert: Source alert that triggers the event.

element : Source element that triggers the event.

name : Name of the opened tab.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert after its tab is selected.

beforetilequery

alert: Source alert that triggers the event.

element : Source element that triggers the event.

request : Request object.

cancel : Prevent a tooltip from being displayed.

Fired for the relevant alert before sending a query for data to the server.

aftertilequery

alert: Source alert that triggers the event.

element : Source element that triggers the event.

response : Response object.

Fired for the relevant alert after a query response received from the server.

beforetilerender

alert: Source alert that triggers the event.

element : Source element that triggers the event.

Fired for the relevant alert before an alert tile is rendered.

aftertilerender

alert: Source alert that triggers the event.

element : Source element that triggers the event.

Fired for the relevant alert after an alert tile is rendered.

loaded

 

Fired after all alerts are loaded and rendered.

 

Alert

Contains an alert’s properties and trigger life cycle events.

Properties

 

Property

Type

Description

name

string

Name of the alert.

type

string

Type of the alert ('build', 'kpi', and etc.).

category

string

Category of the alert ('system', 'kpi', and etc.).

action

object

Describes notification options.

enabled

boolean

Defines if an alert enabled or disabled.

 

Events

 

Event name

Event Arguments

Description

beforetooltipconfig

element : Source element that triggers the event.

name : Tooltip name.

tooltipConfig : {

  scope,

  template,

  templateUrl

}

tooltipUi : {

  css,

  placement: {

      place,

      anchor

  },

  radial,

  showDuration,

  initialShowDelay,

  betweenShowDelay

}

Fired before a tooltip is created. You can use this event to configure an alert's tooltip appearance.

beforetooltip

element : Source element that triggers the event.

name : Tooltip name.

tooltipPos : {

  x,

  y

}

cancel : Prevent a tooltip from being displayed.

Fired before displaying a tooltip.

beforemenu

element : Source element that triggers the event.

items : Array of items to be displayed.

cancel : Prevent a menu from being displayed.

Fired before showing an alert’s configuration menu.

tabselected

element : Source element that triggers the event.

name : Name of the opened tab.

cancel : Prevent a tab from being displayed.

Fired after an alert tab selected.

beforequery

element : Source element that triggers the event.

request : Request object.

cancel : Prevent a query from being sent.

Fired before sending a query for data to the server.

afterquery

element : Source element that triggers the event.

response : Response object.

Fired after a query response is received from the server.

beforerender

element : Source element that triggers the event.

Fired before an alert tile is rendered.

afterrender

element : Source element that triggers the event.

Fired after an alert tile is rendered.

  • No labels