Source: 3rdparty/dvt/doc/ojtagcloud_options.js

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

/**
 * Defines the animation that is applied on data changes.
 * @expose
 * @name animationOnDataChange
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * Defines the animation that is shown on initial display.
 * @expose
 * @name animationOnDisplay
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * An array of category strings used for category filtering. Data items with a category in hiddenCategories will be filtered.
 * @expose
 * @name hiddenCategories
 * @memberof oj.ojTagCloud
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of category strings used for category highlighting. Data items with a category in highlightedCategories will be highlighted.
 * @expose
 * @name highlightedCategories
 * @memberof oj.ojTagCloud
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The matching condition for the highlightedCategories option. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.
 * @expose
 * @name highlightMatch
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "any"
 * @ojvalue {string} "all"
 * @default <code class="prettyprint">"all"</code>
 */
/**
 * Defines the behavior applied when hovering over data items.
 * @expose
 * @name hoverBehavior
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "dim"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * An array of objects with the following properties that defines the data items for the Tag Cloud items.
 * @expose
 * @name items
 * @memberof oj.ojTagCloud
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of category strings corresponding to the Tag Cloud items. This allows highlighting and filtering of items.
 * @expose
 * @name items[].categories
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The id of the tag.
 * @expose
 * @name items[].id
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The text of the tag.
 * @expose
 * @name items[].label
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The description of the tag. This is used for customizing the tooltip text.
 * @expose
 * @name items[].shortDesc
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the text.
 * @expose
 * @name items[].style
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The url this tag references.
 * @expose
 * @name items[].url
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The value of the tag which will be used to scale its font-size within the Tag Cloud.
 * @expose
 * @name items[].value
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The layout to use for tag display.
 * @expose
 * @name layout
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "cloud"
 * @ojvalue {string} "rectangular"
 * @default <code class="prettyprint">"rectangular"</code>
 */
/**
 * An array of id strings, used to define the selected objects
 * @expose
 * @name selection
 * @memberof oj.ojTagCloud
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The type of selection behavior that is enabled on the Tag Cloud.
 * @expose
 * @name selectionMode
 * @memberof oj.ojTagCloud
 * @instance
 * @type {string}
 * @ojvalue {string} "single"
 * @ojvalue {string} "multiple"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 *  A function that returns a custom tooltip. The function takes a dataContext argument, provided by the Tag Cloud, with the following properties: <ul> <li>parentElement: The tooltip element. The function can directly modify or append content to this element.</li> <li>id: The id of the hovered item.</li> <li>label: The data label of the hovered item.</li> <li>color: The color of the hovered item.</li> <li>value: The value of the hovered item.</li> </ul> The function may return an HTML element, which will be appended to the tooltip, or a tooltip string. 
 * @expose
 * @name tooltip
 * @memberof oj.ojTagCloud
 * @instance
 * @type {function(object)}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object defining the default styles for the Tag Cloud. Properties specified on this object may be overridden by specifications on the data object.
 * @expose
 * @name styleDefaults
 * @memberof oj.ojTagCloud
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies initial hover delay in ms for highlighting data items. Also accepts CSS strings such as 1s and 1000ms.
 * @expose
 * @name styleDefaults.hoverBehaviorDelay
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {number|string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the items.
 * @expose
 * @name styleDefaults.style
 * @memberof! oj.ojTagCloud
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */