List of Portlet Properties
This page lists all portlets' properties. Some properties are general to all portlets, others are only available for some portlets. The first table lists the general properties, the second the specific properties.
Both tables indicate
- the Name of the property as indicated in the Portlet Designer,
- the Data type of the property,
- the Controlability of the property by the TIS Board - Adjust Portlet operator,
- the Internal name of the property needed, e.g., for controlling the property by the TIS Board - Adjust Portlet operator, and
- a Description of the property.
Name | Data type | Controllable | Internal name | Description |
---|---|---|---|---|
Name | string | caption | Name of the portlet. | |
Description | string | description | Text to appear above the grid. | |
Description visible | bool | Toggle visibility of description. | ||
Footer | string | Text to appear below the grid. | ||
Footer visible | bool | Toggle visibility of footer. | ||
Last modified visible | bool | Toggle visibility of time of last modification, shown in the footer. | ||
Solution | string | Name of the TIS Project referred to by this portlet. A link that opens the project in TIS Editor in a new tab. Can be changed by the "Change data source" button on top of the settings. | ||
Data node | string | Name of the data node referred to by this portlet. A link that opens the data node in TIS Editor in a new tab. | ||
Path | string | Path to this portlet in the Portlet Explorer | ||
Identifier | string | A string that adds the portlet to a group of portlet. This property is referred to by the TIS Board - Adjust Portlet operator to dynamically modify portlet settings. | ||
Group identifier | string | Group identifier to limit reloads after controller portlet recalculations. | ||
integer | Time interval in seconds to automatically refresh the data in the portlet. "0" for no automatic refresh. | |||
Reload when page changes | bool | Toggle automatic reload of the portlet when the page is opened. | ||
Portlet frame | bool | Toggle framing of the portlet. | ||
Hide in view mode | bool | hidden | Hide the portlet in view mode. | |
Disable Excel export | bool | Remove possibility to export the data to Excel. | ||
Disable printing | bool | Remove printing button. | ||
Rows per page | integer | Number of rows per page, if paging is enabled. | ||
Height (px) | integer | height | Height of the portlet in pixels. | |
Automatic height | Adjust height automatically. |
Specific Portlet Properties
Name | Type | Controllable | Internal name | Description | Available in Portlets |
---|---|---|---|---|---|
Portlet properties | Disable paging | bool | No paging of the data in the Editable Grid (show all rows on one page). | |||
Portlet properties | Show summary while collapsed | bool | collapsed | If Controller portlet is set to be collapsed on an event (e.g. Login), toggle visibility of the portlet summary. | ||
Color preset | Default color theme of the Tiles portlet | ||||
Background color | string | Color as hex code, e.g., #000000 for black | |||
Trigger controller portlets on click | bool | Specify whether clicking on a tile should trigger all controller portlets on the page. | |||
Footer | string | Text to appear at the bottom of a tile | |||
Middle line | string | Text to appear in the middle of a tile | |||
Top line | string | Text to appear at the top of a tile | |||
Bottom text color | string | Color as hex code, e.g., #000000 for black | |||
Middle text color | string | Color as hex code, e.g., #000000 for black | |||
Top text color | string | Color as hex code, e.g., #000000 for black |