Configuration

Overview

The most straightforward way to customize an Safety Explorer Suite is by using a settings object whose properties describe the renderers. All defaults can be over-written by users when creating an AE Explorer.

settings

object

an object passed to safetyExplorerSuite() which controls the settings and appearance of the output.

settings.title

string

Optional title (e.g. study name) to be displayed above the nav.

** default:** null

settings.renderers

array or string

An array listing which safety explorer renderers to include in the output. All available renderers are included by default. valid options are:

• "aeexplorer"
• "ae-timelines"
• "safety-histogram"
• "safety-outlier-explorer"
• "safety-shift-plot"
• "safety-results-over-time"
• "paneled-outlier-explorer"

default: null

settings.custom_settings

array of object

All charts are created using their defaults settings by default (.createChart() is called with {}). Users can provide custom settings by providing a settings object with an added renderer_name field in the settings.custom_settings array. For example, this settings object below would add a site filter for the outlier explorer, while all other charts would use their default values:

var settings =  {
  custom_settings:[
    {
      renderer_name:"safety-outlier-explorer",
      filters:[{value_col:"site_name", label:"Site"}]
    {
  ]
}

default: null