Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. 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
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      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. Referencing 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
      7. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    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. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. 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
    11. Connecting to other data sources
  5. 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
  6. 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
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. 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
  10. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  11. 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.

One more tool needed is Flexmonster CLI, which is the most convenient way to work with Flexmonster. Install the CLI globally using npm:

npm install -g flexmonster-cli

Now a new flexmonster command is available in the console. Learn more about Flexmonster CLI and its commands in our documentation.

After that, choose one of the following options:

  1. Run a sample Vue 2 project from GitHub
  2. Integrate Flexmonster into a Vue 2 application
  3. See the examples of Flexmonster usage in Vue
  4. Integrate Flexmonster into a Vue 3 application

Run a sample Vue 2 project from GitHub

Create the sample project with the following CLI command:

flexmonster create vue -r

The flexmonster create vue command will do the following:

  • Download the .zip archive with the sample Vue project from GitHub.
  • Automatically unpack the files in the current folder — as a result, the flexmonster-vue-project/ folder will appear in your working directory.

The -r option, which stands for --run, completes these tasks:

  • Installs all the npm dependencies described in package.json.
  • Compiles the application and runs it in the browser.

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

Integrate Flexmonster into a Vue 2 application

Follow the steps below to integrate Flexmonster Pivot into a new Vue 2 application. If you already have the Vue project, jump to Step 3. Install Flexmonster.

To integrate Flexmonster with Vue 3, refer to this section.

Step 1. Install the Vue CLI

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. Create a Vue project

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 Flexmonster

Install the Flexmonster Vue module by running this CLI command from the folder containing package.json:

flexmonster add vue-flexmonster

The add command will install the vue-flexmonster package to node_modules/ and add it as an npm dependency to package.json.

Step 4. Register the vue-flexmonster module

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 vue-flexmonster 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> 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 5. Add Flexmonster instance to a Vue component

Include the Pivot module in the <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'">
</Pivot>

</div>
</template>

Step 6. Run the project

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

The sample Vue project with Flexmonster contains several usage examples. You can try them all on the project’s starting page.

This section gives a detailed description of each example:

Adding the pivot table

The first example demonstrates the basic usage of Flexmonster. See how the toolbar, report, and licenseKey initialization parameters are specified in Vue.

Flexmonster has more initialization parameters. Have a look at all of them.

Calling events

This usage example is focused on Flexmonster events. It provides a toggle button for subscribing to all the events and unsubscribing from them.

When Flexmonster is subscribed to the events, the log output displays:

  • Which event was triggered.
  • When the event was triggered.
  • Details on that event.

See the full list of Flexmonster events in our documentation.

Using API calls

The Using API calls section is about customizing the component with API calls. Switch the toggle buttons to:

  • Show the column chart.
  • Show the grid.
  • Make the component read-only.
  • Make the component interactive.

See the full list of Flexmonster API calls.

Updating data

The Updating data section contains an example of data updating at runtime. The example uses the updateData() API call in the function to update the data.

Customizing the Toolbar

Go to the Customizing the Toolbar section to see the example of Toolbar customization.

We use the beforetoolbarcreated event to invoke the customizeToolbar() function. As a result, a custom tab with a custom functionality is added.

Learn more about customizing the Toolbar.

Customizing the grid

The Customizing the grid example demonstrates how the component can be customized.

Switch the toggle buttons to apply or remove customization. Custom grid styles are defined in the customizeCellFunction().

See our documentation to learn more about cell customizing.

Integrating with Highcharts

See an example of integration with Highcharts in the With Highcharts section.

Here are the main elements of this integration:

  1. The Highcharts module and Flexmonster connector for Highcharts.
  2. A container for Highcharts.
  3. The reportcomplete event; when triggered, the function to draw the chart is invoked.
  4. The drawChart() function.

Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.

Integrating with amCharts

In the With amCharts section, you can see a dashboard with Flexmonster and amCharts.

The key elements of this integration are:

  1. The amCharts module and Flexmonster Connector for amCharts.
  2. A container for amCharts.
  3. The reportcomplete event; when triggered, the function to draw the chart is invoked.
  4. The drawChart() function.

Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.

Integrate Flexmonster into a Vue 3 application

To integrate Flexmonster with Vue 3, we will use the Pivot.vue module from GitHub.

Step 1. If needed, uninstall the vue-flexmonster npm module:

npm uninstall vue-flexmonster

Step 2. Download the Pivot.vue source code from GitHub and add it to your project (e.g., to the src/components/ folder).

Step 3. Install the flexmonster npm module:

npm install flexmonster

Step 4. Import Flexmonster styles in main.js:

import { createApp } from 'vue'
import App from './App.vue'
 
import 'flexmonster/flexmonster.css'
 
createApp(App).mount('#app')

Step 5. In the needed component (e.g., in App.vue), import Flexmonster from Pivot.vue:

<script>
import Pivot from "./components/Pivot"

export default {
name: 'App',
components: {
    Pivot
}

}
</script>

<style>...</style>

Step 6. Embed Flexmonster into the needed component (e.g., into App.vue):

<script>
import Pivot from "./components/Pivot"

export default {
name: 'App',
components: {
    Pivot
}
}
</script>

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

</template>

<style>...</style>

Now you can use Flexmonster in your Vue 3 applications.

What’s next?

You may be interested in the following articles: