API - SafetyGraphics/hep-explorer GitHub Wiki

API

hepexplorer(element, settings)

a factory to create a custom Webcharts chart object

returns: chart

Param Type Description
element string CSS selector identifying the element in which to create the chart
settings object settings object specifying options for how the chart is to appear and behave. Options defined here overwrite default values; see Configuration

Events

participantsSelected

The custom participantsSelected event is dispatched to the overall chart wrapper (chart.wrap) whenever the details for a given participant are viewed (or cleared) by clicking on a point in the chart. The event has a custom data property holding an array with the selected ID when a new participant is selected (["123-456-7"]) or an empty array when participant details are cleared.