Dear visitor, despite all the challenges, our team continues operating at full speed.

We are ready to help with any questions you may have. Please fill out this quick form and we'll get back to you.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Component overview
    2. Quick start
    3. System requirements
    4. Troubleshooting
    5. Managing license keys
    6. Migrating from WebDataRocks to Flexmonster
  3. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    3. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
      6. Connecting to other databases
    4. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      3. Configurations reference
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referring the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
    5. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    6. 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
    7. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implementing the custom data source API server
      5. Implementing filters
      6. Supporting more aggregation functions
      7. Returning data for the drill-through view
    8. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    9. 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
  4. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  5. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  6. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Integration with Python
      1. Integration with Django
      2. Integration with Jupyter Notebook
    6. Integration with React Native
    7. Integration with AngularJS (v1.x)
    8. Integration with TypeScript
    9. Integration with R Shiny
    10. Integration with jQuery
    11. Integration with Ionic
    12. Integration with Electron.js
    13. Integration with Webpack
    14. Integration with RequireJS
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with Google Charts
    5. Integration with FusionCharts
    6. Integration with any charting library
  8. Customizing
    1. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
    9. Documentation for older versions
Table of contents

Customizing the 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 you to call its functions on the page from outside of Flexmonster Pivot.

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 tab’s label.
  • id – String. The id used in CSS styles.
  • handler – Function. 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. Arguments to pass to the handler.
  • menu – Array. Dropdown menu items.
  • mobile – Boolean. When set to false, the tab does not show on mobile devices. Default value: true.
  • ios – Boolean. When set to false, the tab does not show on iOS devices. Default value: true.
  • android – Boolean. When set to false false, the tab does not show on Android devices. Default value: true.
  • rightGroup – Boolean. When set to true, the tab is positioned on the right side of the Toolbar. Default value: false.

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: