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

DashboardItemCaptionToolbarOptions Interface

Provides access to the dashboard item's caption elements.

Declaration

export interface DashboardItemCaptionToolbarOptions

Remarks

A dashboard item's caption can contain the following elements:

  • A static item is a control element displayed on the left and only visible if the caption is enabled (for example, the item caption, the data reducing icon).
  • An action item is a control element displayed only when the mouse pointer hovers over the dashboard item caption (for instance, the Export To and Values buttons).
  • A state item is a control element displayed only in specific dashboards states (for example, the Drill Up and Clear Master Filter buttons).
  • A navigation item is a control element allowing to navigate through different dashboard screens.

Use the ViewerToolbarItem class to create a toolbar item.

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

Properties

actionItems Property

Specifies an action items collection.

Declaration

actionItems: Array<ViewerToolbarItem>

Property Value

Type Description
Array<ViewerToolbarItem>

An array of the action toolbar items.

Remarks

An action item is a control element displayed only when the mouse pointer hovers over the dashboard item caption. (for instance, the Export To and Values buttons).

navigationItems Property

Specifies a navigation items collection.

navigationItems: Array<ViewerToolbarItem>
Type Description
Array<ViewerToolbarItem>

An array of the navigation toolbar items.

stateItems Property

Specifies a state items collection.

Declaration

stateItems: Array<ViewerToolbarItem>

Property Value

Type Description
Array<ViewerToolbarItem>

An array of the state toolbar items.

Remarks

A state item is a control element displayed only in specific dashboard states (for example, the Drill Up and Clear Master Filter buttons).

staticItems Property

Specifies a static items collection.

Declaration

staticItems: Array<ViewerToolbarItem>

Property Value

Type Description
Array<ViewerToolbarItem>

An array of the static toolbar items.

Remarks

A static item is a control element displayed on the left and only visible if the caption is enabled (for example, the item caption, the data reducing icon).