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 Controllability 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.
General Portlet Properties
Name | Data type | Controllable | Internal name | Description |
---|---|---|---|---|
Portlet | string | caption |
| |
Description | string | description |
| |
Description header visible | bool | When true, header is shown, otherwise hidden | ||
Footer | string | |||
Footer visible | bool | When true, footer is shown, otherwise hidden | ||
Last modified visible | bool | When true, last modified time stamp is shown in footer | ||
Solution | string | Name of the TIS Project connected to this portlet | ||
Data node | string | Name of the data node connected to this portlet | ||
TIS Table | string | Name of the TIS Table connected to this portlet | ||
Path | string | Path to this portlet in the Portlet Explorer | ||
Name (identifier) | string | Project-unique name of the portlet, used, e.g., by the TIS Board - Adjust Portlet operator. | ||
integer | Time interval in seconds the portlet refreshes (0 for no automatic refresh) | |||
Reload when page changes | bool | |||
Portlet frame | bool | |||
Hide in User mode | bool | |||
integer | ||||
Height (px) | integer | height | Height in pixel (px) of the portlet | |
n/a ( button when portlet included in page) | bool | collapsed | When true, portlet is shown collapsed on a page per default |
Specific Portlet Properties
Name | Type | Controllable | Internal name | Description | Available in Portlets |
---|---|---|---|---|---|
background color | string | Color as hex code, e.g., #000000 for black | |||
bottom text | string | ||||
middle text | string | ||||
top text | string | ||||
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 | |||
hidden | bool |
| |||
footer | string |
| |||
footer visible | bool |
| |||
border | bool |
|