Full JavaScript example

Full dynamic data JavaScript definition object example:
1
{
2
    slicers: { // Defines any value list overrides for any slicers in the report.
3
        cover: { // The name of the page where we are looking to override slicer values.
4
        // This MUST match EXACTLY the page name passed through the "Property name from string:"
5
        // tool on the Settings > Tools page (which calls the ConvertToPropertyName function
6
        // to get the exact property name that the code will be matching to).
7
            resultFromPredefinedFunction: { // The name of the slicer to be dynamically
8
            // populated with values.
9
                name: "My title",
10
                description: "An optional description of the function, its parameters and its return type.",
11
                expression: "TestFunction('M', 2, false)",
12
                selectConditions: 0 // Can be 0 for nothing, 'all' for all, N for selecting
13
                // the first N or -N for selecting last N or a specified condition function
14
                // string that will select a value if the condition returns true.
15
            },
16
            reportingYearEnd: { // Another slicer on the page. (This and the following ones
17
            // actually defines the slicers on our current Cover page for the Smart Financials
18
            // report.)
19
                target: { // Optional unless there are more targets, in which case the containing
20
                // object will become one of several in an array ie. the parent property of this
21
                // will be an array of these objects, not a single object like this one.
22
                    table: "Reporting Year",
23
                    column: "Reporting Year End"
24
                }, // IMPORTANT: If specified the table name and column name must be matching
25
                // exactly to the specification in the report as they are used to create a property
26
                // name on the bases of which matching is done.
27
                name: "Reporting Year End",
28
                description: "",
29
                format: "d MMMM",
30
                multiselect: false,
31
                selectConditions: "value == DateAdd('d', DateAdd('M', DateAdd('y', FY(true), -1), 13), -1)",
32
                // FY(getEnd, date) returns the first day of the financial year to which the passed-in
33
                // date (or the current date if nothing is passed) belongs, or its end date if 'getEnd' = true.
34
                values: [ // Will test the "condition" one after another until one is true.
35
                // Overrides properties in the main definition (like name, description, type etc.).
36
                    {
37
                        name: "LastFY if current less than 2 months",
38
                        descr: "Calculates the start date of the last financial year if we are less than 2 months into the current financial year.",
39
                        condition: "FY(DateAdd('M', Now(), -2)) < FY()",
40
                        // other functions could be CY() = calendar year
41
                        expression: "DatePeriods({periodType:'M', startDate: DateAdd('y', FY(), -1), arraySize: 12, onlyIfAlreadyPassed:, true, day: 'end'})", // DatePeriod(definitionObject) where the definition object
42
                        // has properties like "step", which is the number of the specified
43
                        // period types that the values will differ by from each other (as in
44
                        // if the periodType = "d" and step = 3 then each date in the resulting
45
                        // array will be 3 days apart from the next one), startDate can be higher
46
                        // than end date for a generation of dates with decreasing values, or one
47
                        // of them can be null and the order is determined by whether start or end
48
                        // was supplied, 'day' can be a number, 'start' = 1 and 'end' = the last
49
                        // day of the month in startDate, 'arraySize' is the maximum size of the
50
                        // array/list generated; it is optional if both start and end dates are
51
                        // specified, but compulsory if one of them is null; if both are specified
52
                        // and the arraySize also, the maximum number of items will be the value
53
                        // of arraySize even if the other limit date is not reached in
54
                        // the generating function. Finally the 'reverseOrder' can reverse the
55
                        // final generated list.
56
                        selectConditions: "value == DateAdd('d', DateAdd('M', DateAdd('y', FY(true), -1), 7), -1)"
57
                        // OPTIONAL: This overrides the parent definition's select condition.
58
                    }, {
59
                        name: "CurrentFY",
60
                        descr: "Returns the first date of a financial year.",
61
                        condition: null,
62
                        expression: "DatePeriods({periodType:'M', step: 1, startDate: FY(), endDate: FY(), fullMonths: false, ceiling: true})"
63
                        //DateDiff(periodType, startDate, endDate, fullMonths, ceiling) ...
64
                        // if 'ceiling' is false then the value returned will include the current
65
                        // months only if when we are at the middle or past the middle day of the month.
66
                    }
67
                ]
68
            },
69
            years: {
70
                title: "Years",
71
                format: "yyyy",
72
                multiselect: true,
73
                selectConditions: "all",
74
                expression: "DatePeriods({periodType: 'y', startDate: Year() - 3, periods: 4, ceiling: true})"
75
                // Can be directly in the root (without being wrapped in "values") if we
76
                // only need to specify the 'expression' without a condition, name or
77
                // description.
78
            },
79
            month: {
80
                title: "Month",
81
                format: "MMM yyyy",
82
                multiselect: true,
83
                selectConditions: "(FY() >= value < GetDate(Year(), Month(), 1)) || (Year(value) > 2030)",
84
                expression: "DatePeriods({periodType: 'M', startDate: DateAdd('y', Now(), -3, null, 1), endDate: Now()})"
85
                // Here the DatePeriods generates the periods between start and
86
                // end date where the start date here is calculated by
87
                // DateAdd(periodType, baseDate, number, specificMonth, specificDay)
88
                // which avoids having to calculate DateAdd more than one time inside
89
                // of GetDate(year, month, day)
90
            }
91
        },
92
        page2: {
93
            exampleSlicer1: {
94
                title: "Slicer 1",
95
                multiselect: true,
96
                values: [ // The list of values can also be predefined where each value
97
                // is calculated separately or where it's value is given as a static value.
98
                // This list is an array of arrays.
99
                    ["FormatDate(Now(), 'd MM')", true, false], // The member arrays
100
                    // define the value, whether the value is an expression or a static
101
                    // string and, if it should be pre-selected. These boolean values can
102
                    // be omitted to default to false. If the value is an expression then
103
                    // if it starts with a dot (.), then it is a direct function.
104
                    ["FormatDate(DateAdd('M', Now(), -1, 'd MMMM'))", true],
105
                    ["select a date", false, true]
106
                ]
107
            },
108
            dateRangeSlicer: {
109
                description: "A slicer containing two single-value fields: Date From and Date To. The first will always keep the value defined by the report designer, but the second uses the FY() - FinancialYear function which gets the end date of the current financial year if the first parameter is `true` (and can get a different financial year if a second parameter is passed in the form of a date belonging to the desired financial year).",
110
                conditions: [
111
                    { keepOriginal: true },
112
                    { expression: "FY(true)" }
113
                ]
114
            }
115
        },
116
    page3: {
117
      same_as: [
118
        ["page2", "exampleSlicer1", "dateRangeSlicer"]
119
      ]
120
    },
121
    page4: {
122
      exampleSlicer_page4: {
123
        same_as: ["page2", "exampleSlicer1"]
124
      },
125
      dateRangeSlicer_page4: {
126
        same_as: ["page2", "dateRangeSlicer"]
127
      }
128
    }
129
    }
130
}