Changes between Version 17 and Version 18 of S3/S3Report

Timestamp:

09/10/12 04:51:58 (12 years ago)

Author:

James O'Neill

Comment:

Add info about search option in report_options

S3/S3Report

@@ -63 +63 @@
 The `rows`, `cols`, `facts` and `aggregate` items are lists of available values for the user to select from.
 
-The `defaults` item 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]).
+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]).
+
+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.
 
 Here is an example of a `report_options` item:
 {{{#!python
-report_options = Storage(
-        rows = report_fields,
-        cols = report_fields,
-        facts = report_fields,
-        defaults = Storage(
-                rows = "project_id",
-                cols = "name",
-                fact = "time_actual",
-                aggregate = "sum",
-                totals = True
-        )
+report_options=Storage(
+        rows=report_fields,
+        cols=report_fields,
+        facts=report_fields,
+        defaults=Storage(
+                rows="project_id",
+                cols="name",
+                fact="time_actual",
+                aggregate="sum",
+                totals=True
+        ),
+        search=[
+                S3SearchOptionsWidget(
+                        name="project_id",
+                        label = T("Project"),
+                        field = "project_id",
+                ),
+        ],
+)
 }}}