Interface ToolbarItem

Type representing a viewer's toolbar item.

Example

Usage example:

var pdfExportButton: ToolbarItem = {
    key: '$pdfExportButtonKey',
    checked: true,
    enabled: true,
    iconCssClass: 'mdi mdi-file-pdf',
    text: 'Export to PDF',
    title: 'Export to PDF',
    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);

Hierarchy

  • ToolbarItem

Properties

action checked? enabled? iconCssClass? key onUpdate text? title?

Properties

action

action: (() => void)

Type declaration

    • (): void

    • Action handler for the toolbar item.

      Returns void

Optional checked

checked?: boolean

Shows whether the toolbar item is checked.

Optional enabled

enabled?: boolean

Shows whether the toolbar item is enabled.

Optional iconCssClass

iconCssClass?: string

Specifies css class for the icon of the toolbar item.

key

key: string

The uniq identifier of the toolbar item. See keys of the standard viewer's toolbar buttons here: [[ToolbarButtons]]

onUpdate

onUpdate: (() => ToolbarItem)

Type declaration

Optional text

text?: string

Specifies the text of the toolbar item.

Optional title

title?: string

Specifies the tooltip of the toolbar item.

Settings

Member Visibility

Theme

On This Page