Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Complex Type: xe:dominoViewCloudData

Description

Tag Cloud data coming from a Domino view

Properties

• <xe:dominoViewCloudData
• cacheMode
• cacheRefreshInterval
• categoryColumn
• linkMetaSeparator
• linkRequestParam
• linkTargetPage
• loaded
• maxTagLimit
• minEntryCount
• sortTags
• tagThreshold
• viewName
• />

Java

Java Class: com.ibm.xsp.extlib.component.tagcloud.ViewTagCloudData

loaded, boolean  [Inherited] Loaded Specifies whether or not the tag instance should be created when the page is loading. Value defaults to 'true'. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

viewName, string View Name Required: The name of a categorized view from which the tag cloud should be computed from. The view requires only one categorized column; you do not need to compute document or category counts. Required Attribute true Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

categoryColumn, int Category Column Number Optional: The number of the view column which is categorized. Value defaults to '0' Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

sortTags, string Sort Tags Optional: How the tags should be sorted. Valid values are 'alphabet' and 'weight'. Default value is 'alphabet'. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

maxTagLimit, int Maximum Tag Limit Optional: The 'top' number of tags to be displayed in the tag cloud. Value defaults to 50. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

tagThreshold, int Tag Threshold Optional: Number of new tags that triggers the cloud to be recomputed. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

minEntryCount, int Minimum Entry Count Optional: The minimum number of entries a category/tag must have to be considered for inclusion in the tag cloud. By default the value is automatically adjusted based on the number of documents in the view. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

cacheMode, string Cache Mode When set to 'auto', the cache refresh interval is dynamically adjusted based on the number of entries in the view. When set to 'manual', you can specify the cache refresh interval in the 'refreshInterval' property. Valid values are 'auto', 'manual' and 'off'. Value defaults to 'auto'. It is not recommended to turn off the cache except for debugging purposes. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

cacheRefreshInterval, int Manual Cache Refresh Interval The cache refresh interval in seconds when the cache mode is set to 'manual'. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

linkTargetPage, string Link To Target Page Name Name of the XPage to open when clicking on a tag. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

linkRequestParam, string URL Request Parameter The URL request parameter for tag links (ex: tagName) Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

linkMetaSeparator, string Meta-data Separation Char Optional character which acts as a delimiter between tag data and meta data (to be used in conjunction with the linkRequestParam value) Using a metaSeparator char requires the categorized view column to output the data in the format xxx | yyy, where xxx is the tag name, | is the metaSeparator char, and yyy is the meta data used as the request parameter. If no metSeparator is specified, the actual tag value will be used for the request parameter value. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true