Toolbar is an extra HTML/JS addition to Flexmonster pivot component. It uses standard API and provides easy access to the most used features. Toolbar is free and provided “as is”.
Toolbar is available since version 2.0. Enabling toolbar is very easy, just set the appropriate parameter in new Flexmonster() function to true.
new Flexmonster({
container:String,
componentFolder:String,
global:Object,
width:Number,
height:Number,
report:Object,
toolbar:Boolean,
licenseKey:String})
Use flexmonster.toolbar to get a reference to the Toolbar instance. It allows calling its functions on the page from outside of Flexmonster Pivot.
Please verify that your flexmonster/ folder includes toolbar/ folder and it’s not empty.
Toolbar can be customized via beforetoolbarcreated event. Tabs and buttons can be removed from it and new ones can be added easily.
Subscribe to beforetoolbarcreated. Get all tabs using getTabs() method that returns an Array of Objects, each of them describes a tab. To remove a tab you should just delete corresponding Object from the Array. The following example will remove the first tab:
new Flexmonster({
container: "pivotContainer",
toolbar: true,
licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX",
beforetoolbarcreated: customizeToolbar
});
function customizeToolbar(toolbar) {
// get all tabs
var tabs = toolbar.getTabs();
toolbar.getTabs = function () {
// delete the first tab
delete tabs[0];
return tabs;
}
}
Open the example on JSFiddle.
The following code will add a new tab:
new Flexmonster({
container: "pivotContainer",
toolbar: true,
licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX",
beforetoolbarcreated: customizeToolbar
});
function customizeToolbar(toolbar) {
// get all tabs
var tabs = toolbar.getTabs();
toolbar.getTabs = function () {
// add new tab
tabs.unshift({
id: "fm-tab-newtab",
title: "New Tab",
handler: newtabHandler,
icon: this.icons.open
});
return tabs;
}
var newtabHandler = function() {
// add new functionality
}
}
where:
title – String. Label of the tab.id – String. Id used in CSS styles.handler – String. Name of the function that handles click on this tab.icon – String. HTML tag containing your custom icon for this new tab. You can choose one of the basic vector icons defined in flexmonster.toolbar.js file.Also there are another optional parameters:
args – Any. Argument to pass to handler.menu – Array. Dropdown menu items.mobile – Boolean. If false – doesn’t show on mobile devices.ios – Boolean. If false – doesn’t show on iOS devices.android – Boolean. If false – doesn’t show on Android devices.Check out the example with new tab on JSFiddle.
You can customize almost everything. To explore all the options we recommend investigation of the existing code. Look at the toolbar/ folder (you can find it in the [package]/flexmonster/). Open flexmonster.toolbar.js file. Find the Tab section (it starts with getTabs() method) to understand how it works.
To change appearance of Toolbar read Customizing appearance.