DashboardParameterDialogExtension Class

A Web Dashboard extension that is the Dashboard Parameters dialog.

Declaration

export class DashboardParameterDialogExtension extends DisposableObject implements IExtension

Remarks

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

See the Extension section for information on how to use the HTML JavaScript Dashboard’s client-side API.

Implements

IDisposable

IExtension

Inherited Members

dispose

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 a unique extension name.

Declaration

name: string

Property Value

Type	Description
string	A unique extension name. The return value is ‘dashboard-parameter-dialog’.

Remarks

Warning

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

onHidden Property

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

Declaration

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

Property Value

Type
(e: DashboardParameterDialogArgs) => any

onShowing Property

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

Declaration

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

Property Value

Type
(e: DashboardParameterDialogArgs) => any

onShown Property

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

Declaration

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

Property Value

Type
(e: DashboardParameterDialogArgs) => any

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
DashboardParameterCollection

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