V1
Toolbar ActiveReportsJS API Class

Toolbar Class

Viewer toolbar.

Heirarchy

  • Toolbar

Methods

addItem

  • addItem(item: ToolbarItem): void
  • Adds a new item to the toolbar.

    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.addItem(pdfExportButton);

    Parameters

    • item: ToolbarItem

      An item to be added.

    Returns void

getDefaultToolbarItems

  • getDefaultToolbarItems(): string[]
  • Gets the list of default toolbar items.

    Returns string[]

removeItem

  • removeItem(key: string): void
  • Removes a toolbar item.

    Parameters

    • key: string

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

    Returns void

updateItem

  • updateItem(key: string, itemUpdate?: Partial<ToolbarItem>): void
  • Updates a previously added toolbar item.

    Parameters

    • key: string

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

    • Optional itemUpdate: Partial<ToolbarItem>

      New toolbar item settings.

    Returns void

updateLayout

  • updateLayout(layout: ToolbarLayout): void
  • Defines the toolbar items layout (order and visibility) for different view modes. A parameter is an object with default, full-screen, mobile mode properties (each property is an array of items to be shown in specific views). Setting to default will only affect all modes (full-screen, mobile) if they are not specified externally.

    viewer.toolbar.addItem(pdfExportButton); //now you want to remove everything except pdfExportButton and the navigation block.
    viewer.toolbar.updateLayout({default: ['$pdfExportButtonKey', '$navigation']});

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

    Parameters

    • layout: ToolbarLayout

    Returns void