JSDoc: Source: 3rdparty/dvt/doc/ojsunburst

/**
 * Specifies the animation duration in milliseconds. Also accepts CSS strings such as 1s and 1000ms. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.
 * @expose
 * @name animationDuration
 * @memberof oj.ojSunburst
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies the animation that is applied on data changes.
 * @expose
 * @name animationOnDataChange
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * Specifies the animation that is shown on initial display.
 * @expose
 * @name animationOnDisplay
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * The color that is displayed during a data change animation when a node is updated.
 * @expose
 * @name animationUpdateColor
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of category strings used for filtering. Nodes with any category matching an item in this array will be filtered.
 * @expose
 * @name hiddenCategories
 * @memberof oj.ojSunburst
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of category strings used for highlighting. Nodes matching all categories in this array will be highlighted.
 * @expose
 * @name highlightedCategories
 * @memberof oj.ojSunburst
 * @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.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "any"
 * @ojvalue {string} "all"
 * @default <code class="prettyprint">"all"</code>
 */
/**
 * Defines the behavior applied when hovering over the nodes.
 * @expose
 * @name hoverBehavior
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "dim"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * Specifies initial hover delay in ms for highlighting items in legend. Also accepts CSS strings such as 1s and 1000ms.
 * @expose
 * @name hoverBehaviorDelay
 * @memberof oj.ojSunburst
 * @instance
 * @type {number|string}
 * @default <code class="prettyprint">null</code>
 */
/**
 *  A function that returns a custom tooltip. The function takes a dataContext argument, provided by the sunburst, 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 node.</li> <li>label: The label of the hovered node.</li> <li>value: The value of the hovered node.</li> <li>radius: The radius of the hovered node.</li> <li>color: The color of the hovered node.</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.ojSunburst
 * @instance
 * @type {function(object)}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object defining default properties for the nodes.
 * @expose
 * @name nodeDefaults
 * @memberof oj.ojSunburst
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the nodes.
 * @expose
 * @name nodeDefaults.borderColor
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The horizontal alignment for labels displayed within the node. Only applies to rotated text.
 * @expose
 * @name nodeDefaults.labelHalign
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "inner"
 * @ojvalue {string} "outer"
 * @ojvalue {string} "center"
 * @default <code class="prettyprint">"center"</code>
 */
/**
 * The CSS style string defining the style of the label.
 * @expose
 * @name nodeDefaults.labelStyle
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The label display behavior for the nodes. More labels are generally displayed when using rotation, with the trade off of readability. When auto is used, rotated or horizontal labels will be used based on the client browser and platform.
 * @expose
 * @name nodeDefaults.labelDisplay
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "horizontal"
 * @ojvalue {string} "rotated"
 * @ojvalue {string} "off"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The color of the node hover feedback.
 * @expose
 * @name nodeDefaults.hoverColor
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The inner color of the node selection feedback.
 * @expose
 * @name nodeDefaults.selectedInnerColor
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The outer color of the node selection feedback.
 * @expose
 * @name nodeDefaults.selectedOuterColor
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies the selection mode.
 * @expose
 * @name selectionMode
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "none"
 * @ojvalue {string} "single"
 * @ojvalue {string} "multiple"
 * @default <code class="prettyprint">"multiple"</code>
 */
/**
 * Specifies whether client side rotation is enabled.
 * @expose
 * @name rotation
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "off"
 * @ojvalue {string} "on"
 * @default <code class="prettyprint">"on"</code>
 */
/**
 * Specifies whether whether the nodes are sorted by size. When sorting is enabled, nodes that have the same parent are sorted in order of descending size.
 * @expose
 * @name sorting
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "on"
 * @ojvalue {string} "off"
 * @default <code class="prettyprint">"off"</code>
 */
/**
 * Specifies the starting angle of the sunburst. Valid values are numbers between 0 and 360.
 * @expose
 * @name startAngle
 * @memberof oj.ojSunburst
 * @instance
 * @type {number}
 * @default <code class="prettyprint">90</code>
 */
/**
 * Specifies the label describing the color metric of the component. This label will be used in the legend.
 * @expose
 * @name colorLabel
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies the label describing the size metric of the component. This label will be used in the legend.
 * @expose
 * @name sizeLabel
 * @memberof oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of objects with the following properties that defines the data for the nodes.
 * @expose
 * @name nodes
 * @memberof oj.ojSunburst
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of objects with properties for the child nodes.
 * @expose
 * @name nodes[].nodes
 * @memberof! oj.ojSunburst
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The id of the node.
 * @expose
 * @name nodes[].id
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An optional array of category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with the legend and other components. The categories array of each node is required to be a superset of the categories array of its parent node. If not specified, the ids of the node and its ancestors will be used.
 * @expose
 * @name nodes[].categories
 * @memberof! oj.ojSunburst
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The relative size of the node.
 * @expose
 * @name nodes[].value
 * @memberof! oj.ojSunburst
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The fill color of the node.
 * @expose
 * @name nodes[].color
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The label for this node.
 * @expose
 * @name nodes[].label
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The horizontal alignment for labels displayed within the node. Only applies to rotated text.
 * @expose
 * @name nodes[].labelHalign
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "inner"
 * @ojvalue {string} "outer"
 * @ojvalue {string} "center"
 * @default <code class="prettyprint">"center"</code>
 */
/**
 * Specifies whether or not the node will be selectable.
 * @expose
 * @name nodes[].selectable
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "off"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The description of this node. This is used for accessibility and also for customizing the tooltip text.
 * @expose
 * @name nodes[].shortDesc
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The pattern used to fill the node.
 * @expose
 * @name nodes[].pattern
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "smallChecker"
 * @ojvalue {string} "smallCrosshatch"
 * @ojvalue {string} "smallDiagonalLeft"
 * @ojvalue {string} "smallDiagonalRight"
 * @ojvalue {string} "smallDiamond"
 * @ojvalue {string} "smallTriangle"
 * @ojvalue {string} "largeChecker"
 * @ojvalue {string} "largeCrosshatch"
 * @ojvalue {string} "largeDiagonalLeft"
 * @ojvalue {string} "largeDiagonalRight"
 * @ojvalue {string} "largeDiamond"
 * @ojvalue {string} "largeTriangle"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * The CSS style string defining the style of the label.
 * @expose
 * @name nodes[].labelStyle
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The label display behavior for the nodes. More labels are generally displayed when using rotation, with the trade off of readability. When auto is used, rotated or horizontal labels will be used based on the client browser and platform.
 * @expose
 * @name nodes[].labelDisplay
 * @memberof! oj.ojSunburst
 * @instance
 * @type {string}
 * @ojvalue {string} "horizontal"
 * @ojvalue {string} "rotated"
 * @ojvalue {string} "off"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The radius of the node relative to the other nodes.
 * @expose
 * @name nodes[].radius
 * @memberof! oj.ojSunburst
 * @instance
 * @type {number}
 * @default <code class="prettyprint">1</code>
 */
/**
 * An array containing the ids of the initially selected nodes.
 * @expose
 * @name selection
 * @memberof oj.ojSunburst
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
Source: 3rdparty/dvt/doc/ojsunburst_options.js
