The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardToolboxGroup Class

A toolbox group that contains dashboard toolbox items.

Declaration

export class DashboardToolboxGroup

constructor(name, title, index, items)

Initializes a new instance of the DashboardToolboxGroup class.

Declaration

constructor(name: string, title: string, index: number, ...items: Array<DashboardToolboxItem>)

Parameters

Name Type Description
name string

A group's unique name.

title string

A group's title that is displayed in the Toolbox.

index number

A number that specifies the group's order in the Toolbox.

items Array<DashboardToolboxItem>

An array of dashboard toolbox items.

Properties

index Property

Specifies the position of the toolbox group within the Toolbox.

Declaration

index: number

Property Value

Type Description
number

A number specifying the position of the current group in the Toolbox.

items Property

Provide an access to the collection of toolbox items obtained from the specified toolbox group.

Declaration

items: KnockoutObservableArray<DashboardToolboxItem>

Property Value

Type Description
KnockoutObservableArray<DashboardToolboxItem>

An array of items obtained from the specified toolbox group.

Remarks

Use the items property to get a list of the DashboardToolboxItem objects from the specified toolbox group.

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

name Property

Specifies a unique name of the dashboard toolbox group.

Declaration

name: string

Property Value

Type Description
string

A string value that is a unique toolbox group name.

Remarks

The name is used to identify a toolbox group in code, while the title is displayed as a group header. For example, the standard toolbox groups have the following names and titles:

name

title

"common"

Common

"maps"

Maps

"filter"

Filter

"layout"

Layout

title Property

Specifies a dashboard toolbox group title.

Declaration

title: string

Property Value

Type Description
string

A string value that is a dashboard toolbox group title.

Remarks

The name is used to identify a toolbox group in code, while the title is displayed as a group header. For example, the standard toolbox groups have the following names and titles:

name

title

"common"

Common

"maps"

Maps

"filter"

Filter

"layout"

Layout