id |
String
|
Date.now()
|
An unique ID of the source |
name |
String
|
""
|
The name of the source |
dimensions |
Array.<Object>
|
'[]'
|
List of all Dimension
Properties
| Name |
Type |
Description |
key |
String
|
Key of the dimension |
text |
String
|
Text of the dimension |
members |
Array.<Object>
|
Member list of the dimension
Properties
| Name |
Type |
Default |
Description |
key |
String
|
|
Key of the member |
text |
String
|
|
Text of the member |
isNegative |
Boolean
|
false
|
true if the member is negative calculation // optional |
isVariance |
Enum
|
NONE
|
Defines if the dimension member is shown as a variance // optional
Properties
| Name |
Type |
Description |
NONE |
String
|
No variance |
ABSOLUTE |
String
|
Absolute variance |
RELATIVE |
String
|
Relative variance |
|
isScenario |
Enum
|
NONE
|
Defines if the dimension member is visualized with a scenario // optional
Properties
| Name |
Type |
Description |
NONE |
String
|
No scenario |
PY |
String
|
Previous year |
AC |
String
|
Actual |
PL |
String
|
Plan |
FC |
String
|
Forecast |
|
isScenarioVar |
Enum
|
NONE
|
Defines the second scenario. Only used for variances // optional
Properties
| Name |
Type |
Description |
NONE |
String
|
No scenario |
PY |
String
|
Previous year |
AC |
String
|
Actual |
PL |
String
|
Plan |
FC |
String
|
Forecast |
|
informations |
String
|
|
Additional informations for the member from root system. Those will be returned in the callback functions // optional |
hierarchy |
Object
|
|
Defines the hierarchy informations of the member // optional
Properties
| Name |
Type |
Default |
Description |
parent |
String
|
null
|
sets the members parent key, null if the element is at top level // optional |
IsNode |
Boolean
|
false
|
true if the member is a node, false or empty when not // optional |
isExpanded |
Boolean
|
false
|
true if the member is expanded, fals eor empty when collapsed // optional |
|
|
|
filter |
Object
|
'{}'
|
Defines the background filter for the data // optional
Properties
| Name |
Type |
Description |
dimKey |
Object
|
The dimension key of the selected filter, where [dimKey] needs to replace by the dimension key
Properties
| Name |
Type |
Default |
Description |
name |
String
|
|
The name of the filter // optional |
type |
Enum
|
SINGLE
|
the type of the filter // optional
Properties
| Name |
Type |
Description |
SINGLE |
Object
|
Only one member is selected |
CONSOLIDATED |
Object
|
More than one member are selected |
|
consolidation |
Enum
|
AVERAGE
|
Defines the consolidation type. Only used for type = CONSOLIDATED // optional
Properties
| Name |
Type |
Description |
ADDITION |
String
|
Added all consolidated memberKeys |
MULTIPLICATION |
String
|
Multiplies all consolidated memberKeys |
MAX |
String
|
Takes the maximum value of all consolidated memberKeys |
MIN |
String
|
Takes the minimum value of all consolidated memberKeys |
AVERAGE |
String
|
Defines the average of all consolidated memberKeys |
|
memberKeys |
Array.<String>
|
|
The selected member keys. For the type = SINGLE only the first member has meaning |
|
|
period |
Object
|
'{}'
|
Defines the time period for this data // optional
Properties
| Name |
Type |
Description |
type |
Enum
|
Defines the steps of the selected period
Properties
| Name |
Type |
Description |
YEARS |
String
|
Year steps |
QUARTERS |
String
|
Quarter steps |
MONTHS |
String
|
Month steps |
WEEKS |
String
|
Week steps |
DAYS |
String
|
Day steps |
|
startDate |
Object
|
Start date of the period
Properties
| Name |
Type |
Description |
day |
Number
|
Day |
month |
Number
|
Month |
year |
Number
|
Year |
|
endDate |
Object
|
End date of the period
Properties
| Name |
Type |
Description |
day |
Number
|
Day |
month |
Number
|
Month |
year |
Number
|
Year |
|
|
columns |
Array.<Array.<Number>>
|
'[]'
|
Defines the x-axis members. The length must correspond the number of dimensions. The length of the inner column arrays must correspond the length of inner data array. (-1, if the dimension member is not an element of the axis) |
rows |
Array.<Array.<Number>>
|
'[]'
|
Defines the y-axis members. The length must correspond the number of dimensions. The length of the inner row arrays must correspond the length of data array. (-1, if the dimension member is not an element of the axis) |
data |
Array.<Array.<Object>>
|
'[]'
|
List of all data cells
Properties
| Name |
Type |
Description |
cell |
Object
|
The cell
Properties
| Name |
Type |
Description |
value |
Number
|
The cells value |
formattedValue |
String
|
The cells formatted value // optional |
informations |
Object
|
The cells additional informations // optional
Properties
| Name |
Type |
Description |
status |
Number
|
Defines the status of the cell - 0: normal, 1: bad, 2: warn, 3: good // optional |
editable |
Boolean
|
true if the cell is editable // optional |
comments |
Array.<Object>
|
The comments of the cell // optional
Properties
| Name |
Type |
Description |
name |
String
|
The name of the commenter |
date |
String
|
The date of the comment |
text |
String
|
The comments text |
type |
Number
|
The type to display the comment - 0: comment, 1: tablecell |
informations |
Object
|
Additional informations for the comment |
|
|
|
|
visualization |
Enum
|
NONE
|
Defines the information, how the CMDXF data looks like // optional
Properties
| Name |
Type |
Description |
NONE |
String
|
No visualization |
TABLE_TIME |
String
|
Table timeseries |
SINGLE_TIME |
String
|
Multi axes timeseries (horizontal) bars |
WATERFALL_TIME |
String
|
Multi axes timeseries (horizontal) waterfall bars |
GROUPED_TIME |
String
|
Multi series in one axes timeseries (horizontal) grouped bars |
STACKED_TIME |
String
|
Multi series in one axes timeseries (horizontal) stacked bars |
STACKED100_TIME |
String
|
Multi series in one axes timeseries (horizontal) stacked 100% bars |
POINTLINE_TIME |
String
|
Multi series in one axes timeseries (horizontal) point lines |
TABLE_STRUCTURE |
String
|
Table structure |
SINGLE_STRUCTURE |
String
|
Multi axes structure (vertical) bars |
WATERFALL_STRUCTURE |
String
|
Multi axes structure (vertical) waterfall bars |
GROUPED_STRUCTURE |
String
|
Multi series in one axes structure (vertical) grouped bars |
STACKED_STRUCTURE |
String
|
Multi series in one axes structure (vertical) stacked bars |
STACKED100_STRUCTURE |
String
|
Multi series in one axes structure (vertical) stacked 100% bars |
POINTLINE_STRUCTURE |
String
|
Multi series in one axes structure (horizontal) point lines |
|
chartMultiplier |
dimKey
|
""
|
Defines the dimension key, which multiplies the data in one chart for each member// optional |