The first object in a JSON array can be used to define data types, captions, hierarchies with multiple levels, to group several fields in one dimension, etc. Here is the list of supported properties that can be used in the first object of the input array:
type – the data type. Can be:"string" – the field contains string data. You will be able to aggregate it only with count and distinct count aggregations. It will be sorted as string data."number" – the field contains numeric data. You will be able to aggregate it with all available aggregations. It will be sorted as numeric data."level" – the field is a level of the hierarchy. This type is used together with other properties such as hierarchy, level and parent."month" – the field contains months."weekday" – the field contains days of the week."date" – the field is a date. Such fields will be split into 3 different fields: Year, Month, Day."date string" – the field is a date. Such fields will be formatted using a date pattern (default is dd/MM/yyyy)."year/month/day" – the field is a date. You will see such dates as hierarchies: Year > Month > Day."year/quarter/month/day" – the field is a date. You will see such dates as hierarchies: Year > Quarter > Month > Day."time" – the field is a time (numeric data). Such fields will be formatted using HH:mm pattern. Min, max, count, and distinct count aggregations can be applied to it."datetime" – the field is a date (numeric data). Such fields will be formatted using dd/MM/yyyy HH:mm:ss pattern. Min, max, count, and distinct count aggregations can be applied to it."id" – the field is an id of the fact. Such fields are used for editing data. This field will not be shown in the Field List."hidden" – the field is hidden. This field will not be shown in the Field List."property" – the field for setting member properties. This field will not be shown in the Field List. For example, it can be used to associate a productID with a product. See the example.caption – the hierarchy caption.hierarchy – the hierarchy name, only necessary if the field is a level of a hierarchy ("type": "level") or if the field is a member property of a hierarchy ("type": "property").level – the caption of the level, only if the field is a level of hierarchy ("type": "level").parent – the caption of the parent level, only if the field is a level of hierarchy ("type": "level").dimensionUniqueName – the dimension unique name. Can be used to group several fields under one dimension.dimensionCaption – the dimension caption. It is used as a display name (folder name in the Field List) when several fields are grouped under one dimension.For example, you can add the following first object in a JSON array and see how it changes the report:
<div id="pivotContainer">The component will appear here</div>
<script src="flexmonster/flexmonster.js"></script>
<script>
var jsonData = [
{
"Color": {type: "string"},
"Country": {type: "level", hierarchy: "Geography",
level: "Country"},
"State": {type: "level", hierarchy: "Geography",
level: "State", parent: "Country"},
"City": {type: "level", hierarchy: "Geography",
parent: "State"},
"Price": {type: "number"},
"Quantity": {type: "number"}
},
{
"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
}
];
var pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
data: jsonData
},
slice: {
rows: [
{ uniqueName: "Color" },
{ uniqueName: "[Measures]" }
],
columns: [
{ uniqueName: "Geography" }
],
measures: [
{ uniqueName: "Price", aggregation: "sum" }
]
}
},
licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
});
</script>
Try on JSFiddle.
Note: if you use a JSON array of arrays you can also add the first object. In this case you do not need to specify hierarchies in the first sub-array. Check out live example.
It is possible to define only necessary types of fields and leave all others empty {}. The type of these fields will be selected automatically. In the following example "Color" was left undefined:
<div id="pivotContainer">The component will appear here</div>
<script src="flexmonster/flexmonster.js"></script>
<script>
var jsonData = [
{
"Color": {},
"Price": {type: "number"}
},
{
"Color" : "green",
"Price" : 174,
"Country" : "Canada",
"City" : "Toronto",
"Discount" : 12
},
{
"Color" : "red",
"Price" : 166,
"Country" : "USA",
"City" : "Los Angeles",
"Discount" : 32
}
];
var pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
data: jsonData
}
},
licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
});
</script>
Note that in the Field List only two fields will be available: "Color" and "Price". All other fields ("Country", "City" etc.) will be omitted because they were not mentioned in the first object of JSON array.
To make date fields be interpreted as a date, you must define the data type as a date. For example, "type": "date", "type": "date string", "type": "year/month/day" or "type": "year/quarter/month/day". Additionally, data from these fields should have a special date format to be understood properly. The pivot table component supports the ISO 8601 date format, for example: "2016-03-20" (just date) or "2016-03-20T14:48:00" (date and time). Other formats aren’t officially supported and may have unexpected results.