DashboardParameterDialogExtension Class

A Web Dashboard extension that is the Dashboard Parameters dialog.

Declaration

export class DashboardParameterDialogExtension extends DisposableObject implements ISupportOptionExtension<DashboardParameterDialogExtensionOptions>

Remarks

To configure the extension, refer to the DashboardParameterDialogExtensionOptions class that contains the Dashboard Parameter Dialog’s options.

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview

Implements

Inherited Members

Inheritance

DisposableObject
DashboardParameterDialogExtension

constructor(dashboardControl)

Initializes a new instance of the DashboardParameterDialogExtension class.

Declaration

constructor(
    dashboardControl: DashboardControl,
    options?: DashboardParameterDialogExtensionOptions
)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

options DashboardParameterDialogExtensionOptions

A DashboardParameterDialogExtensionOptions object that contains the extension options.

Properties

name Property

Specifies the unique extension name.

Declaration

name: string

Property Value

Type Description
string

The unique extension name. The return value is dashboardParameterDialog.

Remarks

Use the dashboardExport name in your applications so you can change the extension options when calling the control’s option method. Before v20.2 the extension name was dashboard-parameter-dialog. You can use the old name only in the DashboardControl.findExtension method.

Warning

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

off Property

Unsubscribes from the DashboardParameterDialogExtension’s events.

Declaration

off: EventSubscriber<DashboardParameterDialogExtensionEvents>

Property Value

Type Description
EventSubscriber<DashboardParameterDialogExtensionEvents>

An event subscription.

on Property

Subscribes to the DashboardParameterDialogExtension’s events.

Declaration

on: EventSubscriber<DashboardParameterDialogExtensionEvents>

Property Value

Type Description
EventSubscriber<DashboardParameterDialogExtensionEvents>

An event subscription.

Remarks

The extension’s on and off methods help you subscribe to and unsubscribe from events.

onHidden Property

A handler for the event that occurs when the Dashboard Parameter dialog is hidden.

Declaration

onHidden: ((e: DashboardParameterDialogArgs) => any)

Property Value

Type Description
(e: DashboardParameterDialogArgs) => any

A function that is executed when the Dashboard Parameter dialog is hidden.

onShowing Property

A handler for the event that occurs before the Dashboard Parameter dialog is shown.

Declaration

onShowing: ((e: DashboardParameterDialogArgs) => any)

Property Value

Type Description
(e: DashboardParameterDialogArgs) => any

A function that is executed before the Dashboard Parameter dialog is shown.

onShown Property

A handler for the event that occurs after the Dashboard Parameter dialog is shown.

Declaration

onShown: ((e: DashboardParameterDialogArgs) => any)

Property Value

Type Description
(e: DashboardParameterDialogArgs) => any

A function that is executed after the Dashboard Parameter dialog is shown.

showDialogButton Property

Declaration

showDialogButton: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

Methods

getParameters Method

Returns dashboard parameter settings and metadata.

Declaration

getParameters(): DashboardParameterCollection

Returns

Type Description
DashboardParameterCollection

A DashboardParameterCollection object that contains parameter settings and metadata.

hide Method

Closes the Dashboard Parameters dialog.

Declaration

hide(): void

renderContent(element) Method

Renders the content of the Dashboard Parameter dialog inside the specified DOM element.

Declaration

renderContent(
    element: JQuery | Element
): ParameterDialogContent

Parameters

Name Type Description
element JQuery | Element

A DOM element where the content of the Dashboard Parameter dialog is rendered.

Returns

Type Description
ParameterDialogContent

A content of the Dashboard Parameter dialog.

show Method

Invokes the Dashboard Parameters dialog.

Declaration

show(): void

start Method

Contains code that is executed when you register the dashboard extension.

Declaration

start(): void

stop Method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void

subscribeToContentChanges(callback) Method

Declaration

subscribeToContentChanges(
    callback: (newValue: DashboardParameterCollection) => void
): ko.Subscription

Parameters

Name Type
callback (newValue: DashboardParameterCollection) => void

Returns

Type
Subscription