Menu
Download Free Trial
Table of contents

Flexmonster

new Flexmonster({
    container: String,
    componentFolder: String,
    global: ReportObject,
    width: Number,
    height: Number,
    report: ReportObject | String,
    toolbar: Boolean,
    customizeCell: Function,
    licenseKey: String
})

[starting from version: 2.4]

Embeds the component into the HTML page. This method allows you to insert the component into your HTML page and to provide it with all necessary information for the initialization. This is the first API call you need to know.

Starting from version 2.3, you can preset options for all reports using global object.

Note: Please do not forget to import flexmonster.js before you start working with it.

Parameters

    • container – the selector of the HTML element you would like to have as a container for the component.
    • componentFolder – URL of the component’s folder which contains all necessary files. Also, it is used as a base URL for report files, localization files, styles and images. The default value for componentFolder is flexmonster/.
    • global – object that allows you to preset options for all reports. These options can be overwritten for concrete reports. Object structure is the same as for Report Object.
    • width – width of the component on the page (pixels or percent). The default value for width is 100%.
    • height – height of the component on the page (pixels or percent). The default value for height is 500.
    • report – property to set a report. It can be inline Report Object or URL to report JSON. XML reports are also supported in terms of backward compatibility.
    • toolbar – parameter to embed the toolbar or not. Default value is false – without the toolbar.
    • customizeCell – function that allows customizing of separate cells.
    • licenseKey – the license key.

Event handlers can also be set as properties for Flexmonster object. Check the list here.

    The only required property is container. If you run new Flexmonster({container: "pivotContainer"}), where "pivotContainer" is the selector of container HTML element, – an empty component without the toolbar will be added with the default width and height.

    Returns

    Object, the reference to the embedded pivot table. If you want to work with multiple instances on the same page use these objects. All API calls are available through them.

    Examples

    1) Add the component instance to your web page without the toolbar:

    <div id="pivotContainer">The component will appear here</div> 
    <script src="flexmonster/flexmonster.js"></script>
    
    <script>
    	var pivot = new Flexmonster({
    		container: "pivotContainer",
    		report: {
    			dataSource: {
    				filename: "data.csv"
    			}
    		},
    		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    	});
    </script>

    Check out the example on JSFiddle.

    2) Add the component with the toolbar:

    <div id="pivotContainer">The component will appear here</div> 
    <script src="flexmonster/flexmonster.js"></script>
    
    <script>
    	var pivot = new Flexmonster({
    		container: "pivotContainer",
    		toolbar: true,
    		report: {
    			dataSource: {
    				filename: "data.csv"
    			}
    		},
    		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    	});
    </script>

    Try the example on JSFiddle.

    3) Add and operate with multiple instances:

    <div id="firstPivotContainer">The component will appear here</div> 
    <div id="secondPivotContainer">The component will appear here</div> 
    <script src="flexmonster/flexmonster.js"></script>
    
    <script>
    	var pivot1 = new Flexmonster({
    		container: "pivotContainer",
    		toolbar: true,
    		report: {
    			dataSource: {
    				filename: "data.csv"
    			}
    		},
    		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    	});
    
    	var pivot2 = new Flexmonster({
    		container: "pivotContainer",
    		toolbar: true,
    		report: {
    			dataSource: {
    				filename: "data2.csv"
    			}    	
    		},
    		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    	});
    </script>
    
    <button onclick="javascript: swapReports()">Swap Reports</button>
    <script>
    	function swapReports() {
    		var report1 = pivot1.getReport();
    		var report2 = pivot2.getReport();
    
    		pivot1.setReport(report2);
    		pivot2.setReport(report1);
    	}
    </script>
    

    Try the example on JSFiddle.

    4) Set event handler via Flexmonster():

    var pivot = new Flexmonster ({
    	container: "pivotContainer",
    	toolbar: true,
    	report: {
    		dataSource: {
    			filename: "data.csv"
    		}    	
    	},
    	licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX",
    	ready : function () {
    		console.log("The component was created");
    	}
    });
    

    Open this example on JSFiddle.

    5) How to use customizeCell:

    new Flexmonster({
      	customizeCell: function(cell, data) {
    		// change cell
    	},
    	...
    });
    

    Check out the full example on JSFiddle.

    See also

    list of events