Tag cloud (old) portlet
NOTE! As of SiteVision 3, this "old" Tag cloud portlet has been replaced with the "new" Tag cloud portlet (that relies on a Tag cloud result portlet).
The custom Velocity template in the Tag cloud portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here
| Name | Type and Description |
|---|---|
| portlet | javax.jcr.Node |
| This portlet. See properties below | |
| sitevisionUtils | senselogic.sitevision.api.Utils Opens in new window. |
| The main entry point to all utility classes | |
| jcrSession | javax.jcr.Session |
| The JCR Session | |
| request | javax.portlet.PortletRequest |
| The portlet request |
| Name | Type and Description | |
|---|---|---|
| headerFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| tagFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| headerText | javax.jcr.PropertyType.STRING | |
| The header text of the tag cloud portlet | ||
| showNofHits | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the 'Show number of hits' in the tag cloud configuration | ||
| limitNofTags | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the 'Limit number of tags' in the tag cloud configuration | ||
| nofTagsLimit | javax.jcr.PropertyType.LONG | |
| Corresponds to the value of 'Limit number of tags' in the tag cloud configuration | ||
| limitNofDays | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the 'Limit back in time' in the tag cloud configuration | ||
| nofDaysLimit | javax.jcr.PropertyType.LONG | |
| Corresponds to the valud of 'Limit back in time' in the tag cloud configuration | ||
| tagMaxSize | javax.jcr.PropertyType.LONG | |
| The max size in % | ||
| cloud | javax.jcr.PropertyType.WEAKREFERENCE | |
| The JCR-node containing the tag cloud data. The actual node can be resolved by calling getNode() on this property |
The cloud node has a number of sub nodes which correspond the tags of the tag cloud. It has the following properties:
| Name | Type and Description | |
|---|---|---|
| size | javax.jcr.PropertyType.LONG | |
| The number of tags in the cloud |
A tag node has the following properties:
| Name | Type and Description | |
|---|---|---|
| name | javax.jcr.PropertyType.STRING | |
| The name of the tag. Corresponds to the metadata value | ||
| class | javax.jcr.PropertyType.STRING | |
| The HTML class attribute for the tag | ||
| weight | javax.jcr.PropertyType.LONG | |
| The weight of the tag ranging from 100 to tagMaxSize with steps of 10 | ||
| score | javax.jcr.PropertyType.DOUBLE | |
| The score of the tag corresponding to the number of hits | ||
| link | javax.jcr.PropertyType.STRING | |
| The tag link (only availble if a search result page has been set up in the tag cloud configuration) pointing to the search result page |
Last updated:
se-sto-ste-sv5-1
216.73.217.134
216.73.217.134