dashboardToolbarItemNames Variable

Lists unique names of the dashboard item caption and dashboard title elements.

Declaration

export let dashboardToolbarItemNames: {
    titleFilterText: string;
    titleFilterIcon: string;
    exportMenu: string;
    dashboardTitleImage: string;
    dashboardTitle: string;
    parameters: string;
    itemCaption: string;
    limitVisibleData: string;
    clearMasterFilter: string;
    clearSelection: string;
    drillUp: string;
    values: string;
    multiselection: string;
    initialExtent: string;
    dateTimePeriodMenu: string;
    customDateTimePeriod: string;
    dashboardList: string;
    dashboardFilters: string;
    backButton: string;
    itemFilters: string;
    restoreItem: string;
    maximizeItem: string;
};

Members

Type Name Description
string backButton

Returns to the dashboard items list. The predefined value is 'back-button'.

string clearMasterFilter

Allows you to reset filtering when a dashboard item acts as the Master Filter. To learn more, see Master Filtering. The predefined value is 'clear-master-filter'.

string clearSelection

Allows you to clear the selection inside an item. The predefined value is 'clear-selection'.

string customDateTimePeriod

Allows you to select custom date-time periods for the Range Filter. The predefined value is 'custom-date-time-period'.

string dashboardFilters

Displays filters affecting the current dashboard. This button is only available in mobile layout. The predefined value is 'dashboard-filters'.

string dashboardList

Displays a list of available dashboards. The predefined value is 'dashboard-list'.

string dashboardTitle

Specifies a static text in the dashboard title. The predefined value is 'dashboard-title'.

string dashboardTitleImage

Specifies an image in the dashboard title. The predefined value is 'dashboard-title-image'.

string dateTimePeriodMenu

Allows you to select date-time periods for the Range Filter. The predefined value is 'date-time-period-menu'.

string drillUp

Allows you to return to the previous detail level when this item's drill-down capability is enabled. The predefined value is 'drill-up'.

string exportMenu

Invokes the export menu for a dashboard item or the entire dashboard. To learn how to print individual dashboard items, see Exporting. The predefined value is 'export-menu'.

string initialExtent

Restores the default size and position of the Map dashboard items. The predefined value is 'initial-extent'.

string itemCaption

Displays a static text in the dashboard item caption. The predefined value is 'item-caption'.

string itemFilters

Displays filters affecting the current dashboard item. This button is only available in mobile layout. The predefined value is 'item-filters'.

string limitVisibleData

Shows that visible data is limited. The predefined value is 'limit-visible-data.

string maximizeItem

Expands any dashboard item into the entire dashboard size to examine data in greater detail. Refer to Dashboard Items Layout for more information. The predefined value is 'maximize-item'.

string multiselection

Allows you to filter data by selecting multiple elements in dashboard items. The predefined value is 'multiselection'.

string parameters

Allows end-users to modify dashboard parameter values. To learn more about parameters, see Parameters. The predefined value is 'parameters'.

string restoreItem

Restores the expanded item to its initial state. The predefined value is 'restore-item'.

string titleFilterIcon

Displays the filter icon. The predefined value is 'filter-icon'.

string titleFilterText

Displays the filter text. The predefined value is 'filter-text'.

string values

Invokes a drop-down menu that allows you to switch between provided values (in the pie, card, gauge and map dashboard items). To learn more, see the Providing Data topic for the corresponding dashboard item.