1. API reference
  2. Welcome
    1. Component overview
    2. Quick start
    3. System requirements
    4. Troubleshooting
    5. Managing license keys
  3. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Connecting to JSON using the Data Compressor
      3. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Connecting to CSV using the Data Compressor
      3. Data types in CSV
    3. Database
      1. Connecting to SQL databases
      2. Connecting to other databases
      3. Connecting to a database with Node.js
      4. Connecting to a database with .NET
      5. Connecting to a database with .NET Core
      6. Connecting to a database with Java
      7. Connecting to a database with PHP
    4. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with the Accelerator
      3. Installing the Accelerator as a Windows service
      4. Referring the Accelerator as a DLL
      5. Configuring the authentication process
      6. Configuring a secure HTTPS connection
      7. Troubleshooting
    5. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    6. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
  4. Security
    1. Security in Flexmonster
    2. Security aspects when connecting to an OLAP cube
      1. The data transfer process
      2. Data security
      3. Data access management
    3. Security aspects when connecting to a database
      1. The data transfer process
      2. Data access management
  5. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Number formatting
    6. Conditional formatting
    7. Set the report for the component
    8. Get the report from the component
    9. Date and time formatting
    10. Configuring global options
    11. Export and print
    12. Calculated values
    13. Custom sorting
  6. Integration with frameworks
    1. Available tutorials
    2. Integration with AngularJS (v1.x)
    3. Integration with Angular
    4. Integration with React
    5. Integration with Webpack
    6. Integration with ASP.NET
    7. Integration with jQuery
    8. Integration with JSP
    9. Integration with TypeScript
    10. Integration with RequireJS
    11. Integration with PhoneGap
  7. Integration with charts
    1. Integration with Highcharts
    2. Integration with Google Charts
    3. Integration with FusionCharts
    4. Integration with any charting library
  8. Customizing
    1. Customizing toolbar
    2. Customizing appearance
    3. Customizing context menu
    4. Localizing component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.6 to 2.7
    4. Migration guide from 2.5 to 2.6
    5. Migration guide from 2.4 to 2.5
    6. Migration guide from 2.3 to 2.4
    7. Migration guide from 2.2 to 2.3
    8. Documentation for older versions
Table of contents

Customizing toolbar

About the Toolbar

The Toolbar is an HTML/JS addition to Flexmonster. It uses a standard API and provides easy access to the most commonly used features. The Toolbar is free and provided “as is”.

toolbar

The Toolbar is available since version 2.0. Enabling the Toolbar is very easy, just set the toolbar parameter in the new Flexmonster() function call to true.

new Flexmonster({
    container:String, 
    componentFolder:String, 
    global:Object, 
    width:Number, 
    height:Number, 
    report:Object, 
    toolbar:Boolean, 
    licenseKey:String}) 

Ensure that your flexmonster/ folder includes the toolbar/ folder and that it’s not empty.

Use  flexmonster.toolbar to get a reference to the Toolbar instance. It allows calling its functions on the page from outside of the pivot table.

Customizing

The Toolbar can be customized using the beforetoolbarcreated event. Tabs and buttons can be removed from it and new ones can be easily added.

Removing a tab from the Toolbar

Add a beforetoolbarcreated event handler. Inside the handler you can get all tabs using the getTabs() method that returns an Array of Objects, each of which describes a tab. To remove a tab just delete the 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.

Adding a new tab to the Toolbar

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. The label of the tab.
  • id – String. The id used in CSS styles.
  • handler – String. The name of the function that handles clicks on this tab.
  • icon – String. The HTML tag containing your custom icon for this new tab. You can choose one of the basic vector icons defined in the flexmonster.toolbar.js file.

There are also some optional parameters:

  • args – Any. The argument to pass to the handler.
  • menu – Array. The dropdown menu items.
  • mobile – Boolean. If false – doesn’t appear on mobile devices.
  • ios – Boolean. If false – doesn’t appear on iOS devices.
  • android – Boolean. If false – doesn’t appear on Android devices.

Check out an example of creating a new tab on JSFiddle.

Further customization

You can customize almost everything. To explore all the options we recommend investigating the existing code. Look in the toolbar/ folder (you can find it in [package]/flexmonster/). Open the flexmonster.toolbar.js file. Find the tab section (it starts with the getTabs() function expression) to understand how it works.

To change the appearance of the Toolbar read customizing appearance.

What’s next?

You may be interested in the following articles: