Changes between Version 39 and Version 40 of S3/S3Report

Timestamp:

05/14/18 12:30:22 (7 years ago)

Author:

Dominic König

Comment:

--

S3/S3Report

@@ -76 +76 @@
 
 == Report Options ==
-Table configurations can contain a `report_options` item, which is a Storage object. This object is used to configure reports and report options form. 
 
-The `rows`, `cols`, `facts` and `aggregate` items are lists of available values for the user to select from.
+Table configurations can contain a `report_options` item, which is used to configure reports and the report options form.
 
-The `defaults` property is a Storage object that contains the default values for the report. It can contain a value for `rows`, `cols`, `fact`, `aggregate` and `totals` (as described in [#URLMethods URL Methods]).
+Report_options can contain `rows`, `cols`, `fact` (+optional `methods`), `defaults` and `precision` properties.
 
-The `search` property is a list of S3Search widgets that will allow the report to be filtered. If no `search` property is specified, no filter form will be available.
+The `defaults` property is a dict that contains the default values for the report. It can contain a value for `rows`, `cols`, `fact`, and `totals` (as described in [#URLMethods URL Methods]).
+
+The `precision` property can be used to determine the maximum precision of aggregates for a fact field.
 
 Here is an example of a `report_options` item:
 {{{#!python
-report_options=Storage(
-        rows=report_fields,
-        cols=report_fields,
-        fact=report_fields,
-        defaults=Storage(
-                rows="project_id",
-                cols="name",
-                fact="sum(time_actual)",
-                # Older versions of S3Report used this syntax (no longer supported):
-                #fact="time_actual",
-                #aggregate="sum",
-                totals=True
-        ),
-        search=[
-                S3SearchOptionsWidget(
-                        name="project_id",
-                        label = T("Project"),
-                        field = "project_id",
-                ),
-        ],
-)
+report_options = {
+        "rows": report_fields, # which fields can be pivot table rows (list of selectors)
+        "cols": report_fields, # which fields can be pivot table columns (list of selectors)
+        "fact": report_facts,  # possible facts, list of fact descriptors like "method(selector)"
+        "defaults": {
+                "rows": "project_id",
+                "cols": "name",
+                "fact": "sum(time_actual)",
+                "totals": True,
+        },
+        "precision": {
+                "time_actual": 2,  # round aggregations of this field to 2 decimals
+        },
+}
 }}}
 
@@ -114 +108 @@
 
 {{{#!python
-   report_options = Storage(
-       fact = [selector1, selector2, selector3],
-       methods = [method1, method2], # methods can be omitted, falls back to a list of all supported methods
+   report_options = {
+       "fact": [selector1, selector2, selector3],
+       "methods": [method1, method2], # methods can be omitted, falls back to a list of all supported methods
        ...
-   )
+   }
 }}}
 
@@ -124 +118 @@
 
 {{{#!python
-   report_options = Storage(
-       fact = [
+   report_options = {
+       "fact": [
                "method(selector1)",
                "method(selector2)",
                "method(selector3)",
-               # Older versions of S3Report used this syntax (no longer supported):
-               #(field1, method1),
-               #(field2, method1),
-               #(field2, method2),
-               #(field3, method1),
-              ],
+               ],
        ...
-   )
+   }
 }}}
 
@@ -142 +131 @@
 
 {{{#!python
-   report_options = Storage(
-       fact = [
+   report_options = {
+       "fact": [
                (T("ReportLabel1"), "method(selector1)"),
                (T("ReportLabel2"), "method(selector2)"),
                (T("ReportLabel3"), "method(selector3)"),
-               # Older versions of S3Report used this syntax (no longer supported):
-               #(field1, method1, T("My Report A")),
-               #(field2, method1, T("My Report B")),
-               #(field2, method2, T("My Report C")),
-               #(field3, method1, T("My Report D")),
-              ],
+               ],
        ...
-   )
+   }
 }}}