Interface JumpToDashboardConfig

Configuration for Jump To Dashboard functionality. Allows users to navigate from a widget to another dashboard with contextual filtering.

Properties

enabled

enabled?: boolean

Whether Jump To Dashboard functionality is enabled

Default

true

filtering

filtering?: object

Configuration for filter handling between source and target dashboards

Type declaration

filtering.extraFilters

extraFilters?: Filter[]

Additional filters to apply to the target dashboard

Example

const extraFilters = [dashboardProps.filters[0], dashboardProps.widgets[0].filters[0]]

Default

[]

filtering.includeDashboardFilters

includeDashboardFilters?: string[]

Dashboard-level filter dimensions to pass through

undefined - include all [] - include nothing [string] - include specific dimensions

example: ["[ER.Date (Calendar)]", "[Doctors.Specialty]"]

Default

undefined

filtering.includeWidgetFilters

includeWidgetFilters?: string[]

Widget-level filter dimensions to pass through

undefined - include all [] - include nothing [string] - include specific dimensions

example: ["[ER.Date (Calendar)]", "[Doctors.Specialty]"]

Default

undefined

filtering.mergeWithTargetFilters

mergeWithTargetFilters?: boolean

Whether to merge filters with existing target dashboard filters or replace them

Default

false

interaction

interaction?: object

Configuration for user interaction behavior

Type declaration

interaction.captionPrefix

captionPrefix?: string

Caption prefix for jumping action (i.e in context menu)

Default

'Jump to'

interaction.showIcon

showIcon?: boolean

Whether to show the Jump To Dashboard icon in the toolbar of the source widget

Default

true

interaction.triggerMethod

triggerMethod?: TriggerMethod

How users trigger the jump action Note that not all widgets support both trigger methods

Default

'rightclick'

modal

modal?: object

Configuration for the modal window that will display the target dashboard

Type declaration

modal.height

height?: number

Height of the modal window

Default

85 (when measurementUnit is '%') or 800 (when measurementUnit is 'px')

modal.measurementUnit

measurementUnit?: "%" | "px"

Unit of measurement for width/height

Default

'px'

modal.width

width?: number

Width of the modal window

Default

85 (when measurementUnit is '%') or 1200 (when measurementUnit is 'px')

targetDashboardConfig

targetDashboardConfig?: DashboardConfig

Configuration for the target dashboard display. This configuration will be merged with target dashboard config, having higher priority

Default

{}

targets

targets: JtdTarget[]

List of target dashboards that can be navigated to