Interface ToolbarItems

interface ToolbarItems {
    addItem: ((item) => void);
    getKeys: (() => string[]);
    layout: ((keys) => void);
    removeItem: ((key) => void);
    updateItem: ((key, itemUpdate) => void);
}

Properties

addItem getKeys layout removeItem updateItem

Properties

addItem

addItem: ((item) => void)

Adds a new item to the toolbar.

Type declaration

    • (item): void

    • Parameters

      Returns void

Example: Usage example:

var pdfExportButton = {
    key: '$pdfExportButtonKey',
    iconCssClass: 'mdi mdi-file-pdf',
    enabled: true,
    action: function(item) {
        console.log('Export to PDF function works here');
    },
    onUpdate: function(arg, item) {
        console.log('Something in viewer was updated, check/update button state here');
    }
};
viewer.toolbar.desktop.addItem(pdfExportButton);

getKeys

getKeys: (() => string[])

Returns identifiers of default and added buttons in the order in which they will be displayed in the toolbar.

Type declaration

    • (): string[]

    • Returns string[]

Example: Usage example:

viewer.toolbar.desktop.layout(viewer.toolbar.desktop.getKeys().reverse())

layout

layout: ((keys) => void)

Sets the keys of the visible toolbar items and their order.

Type declaration

    • (keys): void

    • Parameters

      • keys: string[]

        The array of the keys of toolbar items to be visible on toolbar in the desired order.

      Returns void

Example: Usage example:

viewer.toolbar.desktop.addItem(pdfExportButton);
// now you want to remove everything except pdfExportButton and the navigation block.
viewer.toolbar.desktop.layout(['$pdfExportButtonKey', '$navigation']);

will create a toolbar with the export button and the "navigation" block.

removeItem

removeItem: ((key) => void)

Removes existing item from the toolbar.

Type declaration

    • (key): void

    • Parameters

      • key: string

        The toolbar item key, as it was specified in the addItem parameters.

      Returns void

Example: Usage example:

viewer.toolbar.desktop.removeItem(pdfExportButton);

updateItem

updateItem: ((key, itemUpdate) => void)

Updates a previously added toolbar item.

Type declaration

    • (key, itemUpdate): void

    • Parameters

      • key: string

        the toolbar item key, as it was specified in the addItem parameters.

      • itemUpdate: ToolbarItem

        New toolbar item settings.

      Returns void

Settings

Member Visibility

Theme

On This Page

addItemgetKeyslayoutremoveItemupdateItem