DashboardToolboxItem Class

A toolbox item of a specified dashboard toolbox group.

Declaration

class DashboardToolboxItem

To obtain a list of dashboard toolbox items in a specified group, get access to the ToolboxExtension extension and use the items method.

var toolboxItems = dashboardControl.findExtension('toolbox').toolboxGroups()[0].items();

Use the addToolboxItem method to add items to the toolbox.

Constructors

Constructor

Declaration

constructor(name: string, click: (itemTypeName: string) => void, icon: string, title?: string, type?: string)

Parameters

Type Name Description
string name
(itemTypeName: string) => void click
string icon
string title
string type

Properties

click Property

Specifies a custom function that is invoked on a click.

Declaration

click: (itemTypeName: string) => void

Property Value

Type Description
(itemTypeName: string) => void

A custom function that is executed when a click occurs.

disabled Property

Specifies whether a toolbox item should be disabled.

Declaration

disabled: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

true, if a toolbox item should be disabled; otherwise, false.

icon Property

Specifies an icon of the dashboard toolbox item.

Declaration

icon: string

Property Value

Type Description
string

A string value that is the icon id from the SVG definition.

Web Dashboard supports icons in the SVG format. To provide an icon for the toolbox element, add the SVG definition onto the page and assign the id value from the definition to the icon property. The recommended icon size is 24 x 24 px.

name Property

Specifies the unique name of the dashboard toolbox item.

Declaration

name: string

Property Value

Type Description
string

A string value that is a toolbox item's unique name.

Use the name property value to address the toolbox item.

title Property

Specifies a dashboard toolbox item title.

Declaration

title: string

Property Value

Type Description
string

A string value that is a dashboard toolbox item title.

type Property

Specifies a dashboard item type.

Declaration

type: string

Property Value

Type Description
string

A string value that is a dashboard item type.