/**
* <table class="keyboard-table">
* <thead>
* <tr>
* <th>Target</th>
* <th>Gesture</th>
* <th>Action</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td rowspan="2">Legend Item</td>
* <td><kbd>Tap</kbd></td>
* <td>Filter when <code class="prettyprint">hideAndShowBehavior</code> is enabled.</td>
* </tr>
* <tr>
* <td><kbd>Press & Hold</kbd></td>
* <td>Highlight when <code class="prettyprint">hoverBehavior</code> is enabled.</td>
* </tr>
* </tbody>
* </table>
* @ojfragment touchDoc - Used in touch gesture section of classdesc, and standalone gesture doc
* @memberof oj.ojLegend
*/
/**
* <table class="keyboard-table">
* <thead>
* <tr>
* <th>Key</th>
* <th>Action</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td><kbd>Tab</kbd></td>
* <td>Move focus to next component.</td>
* </tr>
* <tr>
* <td><kbd>Shift + Tab</kbd></td>
* <td>Move focus to previous component.</td>
* </tr>
* <tr>
* <td><kbd>UpArrow</kbd></td>
* <td>Move focus to previous item.</td>
* </tr>
* <tr>
* <td><kbd>DownArrow</kbd></td>
* <td>Move focus to next item.</td>
* </tr>
* <tr>
* <td><kbd>LeftArrow</kbd></td>
* <td>Move focus to previous item (on left).</td>
* </tr>
* <tr>
* <td><kbd>RightArrow</kbd></td>
* <td>Move focus to next item (on right).</td>
* </tr>
* <tr>
* <td><kbd>Enter</kbd></td>
* <td>Hides or unhides the data associated with the current item.</td>
* </tr>
* </tbody>
* </table>
* @ojfragment keyboardDoc - Used in keyboard section of classdesc, and standalone gesture doc
* @memberof oj.ojLegend
*/
// SubId Locators **************************************************************
/**
* <p>Sub-ID for legend section indexed by its position in the legend's sections array.</p>
*
* @property {Array} indexPath The array of numerical indices for the section.
*
* @ojsubid oj-legend-section
* @memberof oj.ojLegend
*
* @example <caption>Get the first section:</caption>
* var nodes = $( ".selector" ).ojLegend( "getNodeBySubId", {'subId': 'oj-legend-section', indexPath: [0]} );
*/
/**
* <p>Sub-ID for legend items indexed by their section and item indices.</p>
*
* @property {Array} sectionIndexPath The array of numerical indices for the section.
* @property {number} itemIndex The index of the item within the specified section.
*
* @ojsubid oj-legend-item
* @memberof oj.ojLegend
*
* @example <caption>Get the second item in the first section:</caption>
* var nodes = $( ".selector" ).ojLegend( "getNodeBySubId", {'subId': 'oj-legend-item', sectionIndexPath: [0], itemIndex: 1} );
*/
/**
* <p>Sub-ID for the the legend tooltip.</p>
*
* <p>See the <a href="#getNodeBySubId">getNodeBySubId</a> and
* <a href="#getSubIdByNode">getSubIdByNode</a> methods for details.</p>
*
* @ojsubid
* @member
* @name oj-legend-tooltip
* @memberof oj.ojLegend
* @instance
*
* @example <caption>Get the tooltip object of the legend, if displayed:</caption>
* var nodes = $( ".selector" ).ojLegend( "getNodeBySubId", {'subId': 'oj-legend-tooltip'} );
*/
// Node Context Objects ********************************************************
/**
* <p>Context for legend section indexed by its position in the legend's sections array.</p>
*
* @property {Array} indexPath The array of numerical indices for the section.
*
* @ojnodecontext oj-legend-section
* @memberof oj.ojLegend
*/
/**
* <p>Context for legend items indexed by their section and item indices.</p>
*
* @property {Array} sectionIndexPath The array of numerical indices for the section.
* @property {number} itemIndex The index of the item within the specified section.
*
* @ojnodecontext oj-legend-item
* @memberof oj.ojLegend
*/
Source: src/main/javascript/oracle/oj/ojlegend/ojlegend_doc.js
Oracle® JavaScript Extension Toolkit (JET)
1.1.2
E65298-01