List of plugin parameters
Note: These features are part of the Visforms Subscription and are not included in the free Visforms version.
For a better understanding, we recommend reading the documentation completely and using the
Section Introduction
to start.
Relationships explained in earlier sections of the documentation are not repeated here.
Numerous other parameters in the plugin string
The plugin requires the two mandatory parameters formid and fieldlist.
The plugin also supports numerous other parameters in the plugin string.
This enables an individual configuration of the presentation of the data in the article.
Below is a full list of parameters. This summarizes all the important information you need to be able to use the parameters effectively.
List of all parameter names and allowed values
You can find the correct parameter name in the “Name” column.
The “Value” column shows which values are permitted for the respective parameter.
The “Default value” column shows whether there is a default value for the parameter in the plugin.
If you do not list such parameters in the plugin string, then it is still set with the listed default value.
You only have to include these parameters in the plugin string if you use a different value and want to overwrite the default value.
Note: See the "Function" column of the table for a description of how each parameter works.
Note: For some plugin parameters, the corresponding parameter must also be enabled in the form configuration.
For the following plugin parameters to work, the corresponding parameter must also be activated in the form configuration:
- Form Configuration » Tab: Data Display in the Frontend
Group: Basic Settings
- displayid
- displayip
- displayismfd
- displaycreated
- displaycreatedtime
- displaymodified
- displaymodifiedtime
- displaycounter
- Form Configuration » Tab: Data Display in the Frontend
Group: Downloads
- displaypdfexportbutton
- displaycsvexportbutton
- Form Configuration » Tab: Data Display in the Frontend
Group: Data Detail
- displaydetail
| Name | Default value | Value | Function | Mandatory field |
|---|---|---|---|---|
| formid | No default value set | Form ID | Select the form whose data you want to display. | yes |
| fieldlist | No default value set | Comma separated list of field IDs | Selection of the fields whose data you want to display. | yes |
| hidden_fields | No default value set | Comma separated list of field IDs. Can only contain fields that are in the fieldlist. | Use this parameter in conjunction with the search filters. You can use this parameter to search in fields that should not be displayed. Put all fields that should only be searched but not displayed in the hidden_fields. | no |
| fieldselect | No default value set | List of field IDs and allowed values | Record selection. You can select data records based on specific values or with the help of variables. See the section Select Records. | no |
| layout | No default value set | "list" | Data view layout. You have the choice between a table view and an output of the data in a definition list. In the definition list, the individual data records are displayed one below the other. If the parameter is not set, the table view is displayed. | no |
| show_page_heading | "true" | "true" or "false" | Control display of form title. "true" = show, "false" = hide | no |
| showlabel | "true" | "true" or "false" | Show column headers in table view, labels in list view. "true" = show, "false" = hide | no |
| sortorder | "id" | Number (ID field), "created", "created_by", "checked_out", "checked_out_time", "ipaddress", "modified" or "modified_by" | Field that specifies how the data should be sorted. | no |
| fieldorder | No default value set | "dataordering" |
Specifies the field order. The empty value (default) creates the field order according to the field order specified for the form (field list >> sorting "position in form" >> drag & drop of rows). The value "dataordering" creates the field order according to the field order specified for the data view (field list >> sorting "position in data view" >> drag & drop of rows). See also Changing Field Orders. |
no |
| sortdirection | "asc" | "asc" or "desc" | Sort order of the data. "asc" = ascending, "desc" = descending | no |
| display_num | "20" | Number | Number of records per page. | no |
| count | No default value set | Number | Maximum number of records to be displayed. If this parameter is set, all data records in the selected number are displayed on one page and no pagination is displayed. | no |
| displayid | "true" | "true" or "false" | Show record ID. | no |
| displayip | "false" | "true" or "false" | Show IP. | no |
| displayismfd | "false" | "true" or "false" | Show whether record has been modified. | no |
| displaycreated | "false" | "true" or "false" | Display the submission date of the record. | no |
| displaycreatedtime | "false" | "true" or "false" | If the record submission date is shown, show only date or date and time? | no |
| displaymodifiedat | "false" | "true" or "false" | Show record modification date. | no |
| displaymodifiedattime | "false" | "true" or "false" | If displaying record modification date, display only date or date and time? | no |
| displaycreatedby | "false" | "true" or "false" | Show creator information. | no |
| displaymodifiedby | "false" | "true" or "false" | Show information from the last editor. | no |
| maxtextlength | "0" | Number | Shorten long texts.
The number indicates how many characters are displayed. If the parameter is set to "0", then no characters are truncated. A value of "255" does not truncate input in "Text" type fields. Because fields of the "Text" type only allow a maximum of 255 characters. Longer entries in fields of the "Textarea" type, on the other hand, are truncated. |
no |
| viewclass | No default value set | Any String | String to add to the class attribute in the HTML wrapping tag of the data.
The two HTML wrapping tags affected are table and dl. If you use a Bootstrap template on your website, you can insert the required CSS classes into the HTML tag and format the data view with Bootstrap CSS. For example, use dl-horizontal to style the definition list in the list layout with the appropriate bootstrap CSS for definition lists. Or use table to style the table layout with Bootstrap Table CSS. |
no |
| show_filter | "false" | "true" or "false" | Show search filter above data table and put sorting grid on table headers. | no |
| displaydetail | "false" | "true" or "false" | Insert a link to the detailed view of the record in the table view. More on this here: Table view with detail view. | no |
| displaydetailtitle | "false" | "true" or "false" | Show title above detail view. | no |
| displaycounter | "false" | "true" or "false" | Show an additional counter column. | no |
| show_filter_created | "false" | "true" or "false" | Show additional filter for creation date in search filters. | no |
| displaypdfexportbutton | "false" | "true" or "false" | Show PDF export buttons. | no |
| displaycsvexportbutton | "false" | "true" or "false" | Show CSV export buttons. | no |