$options

Options array with the following possibilities:

• id
  Optional unique identifier for the grid's container div. This is required if there is more than one grid on a single web page to allow separation of the page and sort $_GET parameters in the URLs generated.
• reportGroup
  When joining multiple reports together, this can be used on a report that has autoParamsForm set to false to bind the report to the parameters form from a different report by giving both report controls the same reportGroup string. This will only work when all parameters required by this report are covered by the other report's parameters form.
• rememberParamsReportGroup
  Enter any value in this parameter to allow the report to save its parameters for the next time the report is loaded. The parameters are saved site wide, so if several reports share the same value and the same report group then the parameter settings will be shared across the reports even if they are on different pages of the site. For example if several reports on the site have an ownData boolean parameter which filters the data to the user's own data, this can be set so that the reports all share the setting. This functionality requires cookies to be enabled on the browser.
• mode
  Pass report for a report, or direct for an Indicia table or view. Default is report.
• readAuth
  Read authorisation tokens.
• dataSource
  Name of the report file or singular form of the table/view.
• view When loading from a view, specify list, gv or detail to determine which view variant is loaded. Default is list.
• itemsPerPage
  Number of rows to display per page. Defaults to 20.
• columns
  Optional. Specify a list of the columns you want to output if you need more control over the columns, for example to specify the order, change the caption or build a column with a configurable data display using a template. Pass an array to this option, with each array entry containing an associative array that specifies the information about the column represented by the position within the array. The associative array for the column can contain the following keys: - fieldname: name of the field to output in this column. Does not need to be specified when using the template option. - display: caption of the column, which defaults to the fieldname if not specified - actions: list of action buttons to add to each grid row. Each button is defined by a sub-array containing values for caption, visibility_field, url, urlParams, class, img and javascript. The visibility field is an optional name of a field in the data which contains true or false to define the visibility of this action. The javascript, url and urlParams values can all use the field names from the report in braces as substitutions, for example {id} is replaced by the value of the field called id in the respective row. In addition, the url can use {currentUrl} to represent the current page's URL, {rootFolder} to represent the folder on the server that the current PHP page is running from, and {imageFolder} for the image upload folder. Because the javascript may pass the field values as parameters to functions, there are escaped versions of each of the replacements available for the javascript action type. Add -escape-quote or -escape-dblquote to the fieldname for quote escaping, or -escape-htmlquote/-escape-htmldblquote for escaping quotes in HTML attributes. For example this would be valid in the action javascript: foo("{bar-escape-dblquote}"); even if the field value contains a double quote which would have broken the syntax. Set img to the path to an image to use an image for the action instead of a text caption - the caption then becomes the image's title. The image path can contain {rootFolder} to be replaced by the root folder of the site, in this case it excludes the path parameter used in Drupal when dirty URLs are used (since this is a direct link to a URL). - visible: true or false, defaults to true - template: allows you to create columns that contain dynamic content using a template, rather than just the output of a field. The template text can contain fieldnames in braces, which will be replaced by the respective field values. Add -escape-quote or -escape-dblquote to the fieldname for quote escaping, or -escape-htmlquote/-escape-htmldblquote for escaping quotes in HTML attributes. Note that template columns cannot be sorted by clicking grid headers. An example array for the columns option is: array( array('fieldname' => 'survey', 'display' => 'Survey Title'), array('display' => 'action', 'template' => 'Edit'), array('display' => 'Actions', 'actions' => array( array('caption' => 'edit', 'url'=>'{currentUrl}', 'urlParams'=>array('survey_id'=>'{id}')) )) ) - json: set to true if the column contains a json string object with properties that can be decoded to give strings that can be used as replacements in a template. For example, a column is returned from a report with fieldname='data', json=true and containing a data value '{"species":"Arnica montana","date":"14/04/2004"}'. A second column with fieldname='comment' contains the value 'Growing on a mountain pasture'. A third column is setup in the report with template set to '
  {species} was recorded on {date}.
  {comment}
  '. The json data and the second column's raw value are all available in the template replacements, so the output is set to '
  Arnice montana was recorded on 14/04/2004.
  Growing on a mountain pasture
  ' template - img: set to true if the column contains a path to an image (relative to the warehouse upload folder). If so then the path is replaced by an image thumbnail with a fancybox zoom to the full image. Multiple images can be included by separating each path with a comma.
• rowId Optional. Names the field in the data that contains the unique identifier for each row. If set, then the elements have their id attributes set to row + this field value, e.g. row37. This is used to allow synchronisation of the selected table rows with a report map output showing the same data.
• includeAllColumns Defaults to true. If true, then any columns in the report, view or table which are not in the columns option array are automatically added to the grid after any columns specified in the columns option array. Therefore the default state for a report_grid control is to include all the report, view or table columns in their default state, since the columns array will be empty.
• headers Should a header row be included? Defaults to true.
• galleryColCount If set to a value greater than one, then each grid row will contain more than one record of data from the database, allowing a gallery style view to be built. Defaults to 1.
• autoParamsForm Defaults to true. If true, then if a report requires parameters, a parameters input form will be auto-generated at the top of the grid. If set to false, then it is possible to manually build a parameters entry HTML form if you follow the following guidelines. First, you need to specify the id option for the report grid, so that your grid has a reproducable id. Next, the form you want associated with the grid must itself have the same id, but with the addition of params on the end. E.g. if the call to report_grid specifies the option 'id' to be 'my-grid' then the parameters form must be called 'my-grid-params'. Finally the input controls which define each parameter must have the name 'param-id-' followed by the actual parameter name, replacing id with the grid id. So, in our example, a parameter called survey will need an input or select control with the name attribute set to 'param-my-grid-survey'. The submit button for the form should have the method set to "get" and should post back to the same page. As a final alternative, if parameters are required by the report but some can be hard coded then those may be added to the filters array.
• fieldsetClass
  Optional. Class name(s) to add to fieldsets generated by the auto parameters form.
• filters
  Array of key value pairs to include as a filter against the data.
• extraParams
  Array of additional key value pairs to attach to the request. This should include fixed values which cannot be changed by the user and therefore are not needed in the parameters form.
• paramDefaults Optional associative array of parameter default values. Default values appear in the parameter form and can be overridden.
• paramsOnly Defaults to false. If true, then this method will only return the parameters form, not the grid content. autoParamsForm is ignored if this flag is set.
• ignoreParams Array that can be set to a list of the report parameter names that should not be included in the parameters form. Useful when using paramsOnly=true to display a parameters entry form, but the system has default values for some of the parameters which the user does not need to be asked about. Can also be used to provide parameter values that can be overridden only via a URL parameter.
• completeParamsForm Defaults to true. If false, the control HTML is returned for the params form without being wrapped in a
  and without the Run Report button, allowing it to be embedded into another form.
• paramsFormButtonCaption Caption of the button to run the report on the report parameters form. Defaults to Run Report. This caption is localised when appropriate.
• paramsInMapToolbar If set to true, then the parameters for this report are not output, but are passed to a map_panel control (which must therefore exist on the same web page) and are output as part of the map's toolbar.
• footer Additional HTML to include in the report footer area. {currentUrl} is replaced by the current page's URL, {rootFolder} is replaced by the folder on the server that the current PHP page is running from.
• downloadLink Should a download link be included in the report footer? Defaults to false.
• sharing Assuming the report has been written to take account of website sharing agreements, set this to define the task you are performing with the report and therefore the type of sharing to allow. Options are reporting (default), verification, moderation, peer_review, data_flow, website (this website only) or me (my data only).
• UserId If sharing=me, then this must contain the Indicia user ID of the user to return data for.
• sendOutputToMap Default false. If set to true, then the records visible on the current page are drawn onto a map. This is different to the report_map method when linked to a report_grid, which loads its own report data for display on a map, just using the same input parameters as other reports. In this case the report_grid's report data is used to draw the features on the map, so only 1 report request is made.
• zoomMapToOutput Default true. When combined with sendOutputToMap=true, defines that the map will automatically zoom to show the records.
• rowClass A CSS class to add to each row in the grid. Can include field value replacements in braces, e.g. {certainty} to construct classes from field values, e.g. to colour rows in the grid according to the data.
• callback Set to the name of a JavaScript function that should already exist which will be called each time the grid reloads (e.g. when paginating or sorting).
• linkToReportPath Allows drill down into reports. Holds the URL of the report that is called when the user clicks on a report row. When this is not set, the report click functionality is disabled.
• linkToReportParam Holds the input parameter to be passed to the report that is called when the user clicks on a report row. The input parameter's full unique identifier is required, which consists of the report group name (defaults to report) followed by a hyphen, then the report parameter name defined in the report XML file, for example "report-location_id" works for the location_id report parameter for a report in the report group "report". When this is not set, the report click functionality is disabled.
• ajax If true, then the first page of records is loaded via an AJAX call after the initial page load, otherwise they are loaded using PHP during page build. This means the grid load will be delayed till after the rest of the page, speeding up the load time of the rest of the page. If used on a tabbed output then the report will load when the tab is first viewed. Default false.