DashboardToolbarGroup Class

A toolbar group that contains dashboard toolbar items.

Declaration

export class DashboardToolbarGroup

constructor(name, title, index, items)

Initializes a new instance of the DashboardToolbarGroup class with specified settings.

Declaration

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

Parameters

Name	Type
name	string
title	string
index	number
items	Array<DashboardToolbarItem>

Properties

index Property

Specifies a position of the toolbar group within the Toolbox.

Declaration

index: number

Property Value

Type	Description
number	A zero-based integer specifying the position of the current toolbar group.

Remarks

Use the index property to get access to the toolbar groups.

items Property

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

Declaration

items: ko.ObservableArray<DashboardToolbarItem>

Property Value

Type	Description
ObservableArray<DashboardToolbarItem>	An array of items obtained from the specified toolbar group.

Remarks

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

name Property

Specifies a unique name of the dashboard toolbar group.

Declaration

name: string

Property Value

Type	Description
string	A string value that is a unique toolbar group name.

title Property

Specifies a dashboard toolbar group title.

Declaration

title: string

Property Value

Type	Description
string	A string value that is a dashboard toolbar group title.