Flexmonster Software License Agreement (“Agreement”) has been revised and is effective as of January 8, 2025.
The following modifications were made:
The modified version of Agreement is available here.
Downloading, installing, and/or continuing to use Flexmonster Software after January 8, 2025, constitutes Licensee’s acceptance of the terms and conditions of the modified version of Agreement. If Licensee does not agree to any of these terms and conditions, they must cease using Flexmonster Software and must not download, install, use, access, or continue to access Flexmonster Software. By continuing to use Flexmonster Software or renewing the license or maintenance after the effective date of these modifications to Agreement, Licensee accepts and agrees to be bound by the terms and conditions of the modified Agreement.
This guide illustrates how to connect Flexmonster to a JSON data source.
You can connect to your JSON data using the client-side or the server-side approach. To connect to a JSON file smaller than 100 MB, use the client-side approach, which is described in this guide.
To connect to a JSON file larger than 100 MB, we recommend using Flexmonster Data Server — our server-side solution for processing large datasets. For more details, refer to the Connecting to JSON using Flexmonster Data Server guide.
Your JSON data should be specified in one of the following formats:
[ { "Color" : "green", "Country" : "Canada", "State" : "Ontario", "City" : "Toronto", "Price" : 174, "Quantity" : 22 }, { "Color" : "red", "Country" : "USA", "State" : "California", "City" : "Los Angeles", "Price" : 166, "Quantity" : 19 } ]
[ ["Color", "Country", "State", "City", "Price", "Quantity"], ["green", "Canada", "Ontario", "Toronto", 174, 22], ["red”, "USA", "California", "Los Angeles", 166, 19] ]Live example
Other JSON formats aren’t officially supported and may have unexpected results.
Note Ensure that dates are also specified in a supported format.
If Flexmonster is not yet embedded, set up an empty component in your webpage:
Complete the Integrating Flexmonster guide. Your code should look similar to the following example:
const pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true
});
Complete the Integration with React guide. Your code should look similar to the following example:
<FlexmonsterReact.Pivot toolbar={true} />
Complete the Integration with Angular guide. Your code should look similar to the following example:
<fm-pivot [toolbar]="true"> </fm-pivot>
Complete the Integration with Vue guide. Your code should look similar to the following example:
<Pivot toolbar />
You can connect Flexmonster to remote, local, or inline JSON data.
Remote JSON data can be a remote JSON file or data generated by a server-side script. Flexmonster can be connected to remote JSON data in one of the following ways:
To connect to remote JSON data via UI, use the Toolbar:
Step 1. On the Toolbar, select Connect > To remote JSON. As a result, the Open remote JSON pop-up window will appear.
Step 2. Enter the URL to your JSON data in the input field and click Open.
To connect to remote JSON data in the report, use the dataSource.filename property:
report: {
dataSource: {
filename: "<url-to-remote-json-data>"
}
}
If your data for Flexmonster is stored in a nested JSON property, define the path to that property in the dataSource.dataRootPath.
For example, look at the structure of the following JSON file:
{
"creationDate": "01-01-2022",
"userData": {
"flexmonsterData": [
// Your data
]
}
}
As you can see, the needed data is stored in the userData.flexmonsterData
property. To connect Flexmonster to this data, set the dataRootPath
property to "userData.flexmonsterData"
:
report: {
dataSource: {
filename: "<url-to-remote-json-data>",
dataRootPath: "userData.flexmonsterData"
},
// Other configs
}
To connect to remote JSON data at runtime, use the connectTo() or updateData() API call with the DataSourceObject input parameter. For details on data source configurations, go to the In the report tab.
connectTo()
API call:pivot.connectTo({Live example
filename: "<url-to-remote-json-data>"
});
updateData()
API call:pivot.updateData({Live example
filename: "<url-to-remote-json-data>"
});
The pivot table can be connected to a JSON file from your computer in one of the following ways:
To connect to a local JSON file via UI, use the Toolbar:
Step 1. On the Toolbar, select Connect > To local JSON. As a result, the file manager will appear.
Step 2. Select the file via the file manager.
To connect to a local JSON file in the report, use the dataSource.browseForFile property:
report: {
dataSource: {
type: "json",
browseForFile: true
}
}
Note The type
property must be defined explicitly.
To connect to a local JSON file at runtime, use the connectTo() or updateData() API call with the DataSourceObject input parameter. For details on data source configurations, go to the In the report tab.
connectTo()
API call: pivot.connectTo({
type: "json",
browseForFile: true
});
Note The type
property must be defined explicitly.
updateData()
API call: pivot.updateData({
type: "json",
browseForFile: true
});
Note The type
property must be defined explicitly.
The pivot table can be connected to inline JSON data in one of the following ways:
To connect to inline JSON data in the report, use the dataSource.data property:
const pivot = new Flexmonster({
container: "pivotContainer",
report: {
dataSource: {
data: getData()
}
}
});
function getData() {
return [{
"Category": "Accessories",
"Color": "green",
"Quantity": 22
}];
}
To connect to inline JSON data at runtime, use the connectTo() or updateData() API call with the DataSourceObject input parameter. For details on data source configurations, go to the In the report tab.
connectTo()
API call: pivot.connectTo({Live example
data: getData()
});
function getData() {
return [{
"Country": "Canada",
"Product": "Bike",
"Price": 68450
}];
}
updateData()
API call: pivot.updateData({Live example
data: getData()
});
function getData() {
return [{
"Country": "Canada",
"Product": "Bike",
"Price": 68450
}];
}
When connecting to JSON data, you can use the following properties to configure the DataSourceObject:
Property/Type | Description |
---|---|
type String | The data source type. When connecting to JSON data, set the type to "json" .Note You do not need to specify this property when loading static JSON files with a .json extension. |
browseForFile Boolean | optional Define browseForFile to load a file from the local file system. When set to true , this property opens the file manager, where you can select the necessary file with the data
Live example.Default value: false . |
data JSON | optional The inline JSON data Live example. |
filename String | The URL to a JSON file or to a server-side script that generates JSON data
Live example. If your JSON data is located in a nested property, specify a path to that property in the dataRootPath. |
dataRootPath String | optional The path to a nested JSON property that contains data for Flexmonster
Live example. This property works only for JSON data that is loaded via the filename property and is up to 30 MB in size. Also, ensure your data is specified in a supported JSON data format. The dataRootPath is not compatible with useStreamLoader. |
useStreamLoader Boolean | optional Optimizes processing of large .json files using the stream loader. When set to true , the stream loader is enabled
Live example.useStreamLoader works only when loading files via URL. Not compatible with the dataRootPath property.Default value: false . |
mapping MappingObject | String | optional Defines how fields from the data source are treated and presented within the component. For example, you can specify the field’s captions, define a type for a field, configure multilevel hierarchies, etc. Read more in the Mapping guide. Can be either an inline MappingObject or a URL to a JSON file with the mapping Live example. |
requestHeaders Object | optional Adds custom request headers. Consists of "key": "value" pairs, where "key" is a header name and "value" is its value
Live example.Note The requestHeaders property is not saved when obtaining the report via save() and getReport() API calls. |
withCredentials Boolean | optional Indicates whether cross-site Access-Control requests should be made using credentials such as authorization headers (true ) or not (false ). For more details, refer to MDN web docs.Setting the withCredentials flag to true is recommended when using Windows authentication and other types of server authentication. When set to false , the browser does not ask for credentials and does not include them in outgoing requests.Default value: false . |
You can define how fields from the data source are treated and presented within the component using the mapping. For example, you can:
If your data contains non-Latin characters, ensure you have set UTF-8 encoding for your data and page. This is required to display the data correctly in the component.
If you run into any issues, visit our troubleshooting page.
You may be interested in the following articles: