🎉 Flexmonster Pivot Table & Charts v2.8 has arrived!Read the blog post
Get Free Trial
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. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. 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. MongoDB
      1. Introduction to the Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    5. 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
    6. 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
    7. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    8. 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. Returning data for the drill-through view
      7. Supporting more aggregation functions
  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
    3. Security aspects when connecting to a database
      1. Ways of connecting to a database
      2. The data transfer process
      3. 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 AngularJS (v1.x)
    3. Integration with Angular
    4. Integration with React
    5. Integration with React Native
    6. Integration with Vue
    7. Integration with Python
      1. Integration with Django
      2. Integration with Jupyter Notebook
    8. Integration with R Shiny
    9. Integration with Webpack
    10. Integration with ASP.NET
    11. Integration with jQuery
    12. Integration with JSP
    13. Integration with TypeScript
    14. Integration with RequireJS
    15. 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 the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. 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

Integration with Vue

This tutorial will help you integrate Flexmonster with the Vue framework.

Prerequisites

To run a simple application, you will need Node.js and npm. Get it here if it’s not already installed on your machine.

After that, choose one of the following options:

  1. Integrate Flexmonster into an existing/new application
  2. Run the sample project from GitHub

Integrate Flexmonster into an existing/new application

To integrate Flexmonster into a Vue app, follow these steps:

Step 1. For this tutorial, you will need the Vue CLI. If the Vue CLI is not installed, run the following command in the console to install it globally:

npm install -g @vue/cli

Step 2. If you don’t have a Vue CLI app, create it by running these commands in the console:

vue create project-name
cd project-name

For simple cases, it is enough to select the default configurations when creating a Vue CLI app.

Step 3. Install the Flexmonster Vue package by running the NPM command:

npm i vue-flexmonster --save

Step 4. Install the Flexmonster package with this command:

npm install --save flexmonster

Step 5. Now the vue-flexmonster module can either be used as a plugin (global registration) or locally registered in your project:

  1. To use vue-flexmonster as a plugin, add the following code after existing imports in src/main.js:
    // Using the vue-flexmonster module as a plugin (global registration):
    // 1. Importing the vue-flexmonster module and CSS styles
    import Pivot from "vue-flexmonster";
    import 'flexmonster/flexmonster.css';

    // 2. Referring to the vue-flexmonster module as a plugin
    Vue.use(Pivot);
    Now, any component in your application can use the Pivot.
  2. To use vue-flexmonster locally, insert the following code in the <script></script> section of the component where you need the pivot table (e.g. in the src/App.vue):
    // Using the vue-flexmonster module (local registration):
    // 1. Importing the vue-flexmonster module and CSS styles
    import {Pivot} from "vue-flexmonster";
    import 'flexmonster/flexmonster.css';

    // 2. Defining the module in the components list
    export default {
    name: 'app',
    components: {
    Pivot
    }
    }

Step 6. Include the Pivot module in the <template></template> section of the chosen component (e.g. in the src/App.vue). Make sure the component template contains exactly one root <div> element.

 <template>
<div id="app">
     <Pivot
ref="pivot"
v-bind:report="'https://cdn.flexmonster.com/reports/report.json'"
      v-bind:licenseKey="'XXXX-XXXX-XXXX-XXXX-XXXX'">
</Pivot>

</div>
</template>

Note that licenseKey is your license or trial key, so replace XXXX-XXXX-XXXX-XXXX-XXXX with an actual key. If you don’t have a license key, get a trial key here.

Step 7. Run your application from the console:

npm run serve 

To see the result, open http://localhost:8080/ in your browser.

The application can be shut down manually with Ctrl+C.

Run the sample project from GitHub

Step 1. Download the .zip archive with the sample project or clone it from GitHub with the following command:

git clone https://github.com/flexmonster/pivot-vue.git my-proj
cd my-proj

Step 2. Install the npm packages described in package.json:

npm install

Step 3. Go to the src/components/ folder, then, in all of the available .vue files, add your license or trial key to the Pivot component. If you don’t have a license key, get a trial key here.

<Pivot
ref="pivot"
toolbar
v-bind:report="'https://cdn.flexmonster.com/reports/report.json'"
v-bind:licenseKey="'XXXX-XXXX-XXXX-XXXX'">
</Pivot>

Step 4. Run your application from the console:

npm run serve

To see the result, open http://localhost:8080/ in your browser.

The application can be shut down manually with Ctrl+C.

Examples

  1. A simple usage example
    In the first example, the Pivot component was added with no additional settings applied except the enabled toolbar and the configured report. This example demonstrates the primary functionality of Flexmonster.
  2. Flexmonster events example
    In the second example, you can see the example of usingreportcomplete and cellclick events, passed as arguments to v-bind directives. In the methods section, you can find sample handlers of these events. See the full list of Flexmonster events to learn more about events usage.
  3. Toolbar and cell customizations example
    The third example demonstrates the usage of Flexmonster API methods. See the full list of Flexmonster methods to learn more about methods usage.
    • As it is shown in the example, the beforetoolbarcreated event should be used to customize the toolbar. In the sample project, when the event is triggered, the customizeToolbar function is called. It applies the needed changes to the toolbar. To learn more about the toolbar customization, read this article.
    • You can also find the example of cells customization in the example. In the sample, the customizeCellFunction function is called through the v-bind directive and the customizeCell method as the directive’s argument. To learn more about the custimozeCell method, read this article.

What’s next?

You may be interested in the following articles: