DashboardTitleToolbarOptions Interface

Provides access to the dashboard title’s elements.

Declaration

export interface DashboardTitleToolbarOptions

Remarks

The dashboard title can contain the following elements:

• A content item is a control element displayed on the left or in the center depending on the title alignment.
• An action item is a control element displayed on the right (for instance, the Export To and Parameters buttons).
• A navigation item is a control element that allows you to navigate between different screens (for example, the Back button in the mobile layout).

A toolbar item is the ViewerToolbarItem object.

Refer to the Array documentation for information on how to manage the collection of toolbar items.

Properties

actionItems Property

Specifies a collection of the dashboard title’s action items.

Declaration

actionItems: Array<ViewerToolbarItem>

Property Value

Type	Description
ViewerToolbarItem[]	A collection of toolbar items.

Remarks

An action item is a control element displayed on the right (for instance, the Export To and Parameters buttons).

contentItems Property

Specifies a collection of the dashboard title’s content items.

Declaration

contentItems: Array<ViewerToolbarItem>

Property Value

Type	Description
ViewerToolbarItem[]	A collection of toolbar items.

Remarks

A content item is a control element displayed on the left or in the center depending on the title alignment.

navigationItems Property

Specifies a collection of the dashboard title’s navigation items.

Declaration

navigationItems: Array<ViewerToolbarItem>

Property Value

Type	Description
ViewerToolbarItem[]	A collection of toolbar items.

Remarks

A navigation item is a control element that allows you to navigate between different screens (for example, the Back button in the mobile layout).