/**
* <table class="keyboard-table">
* <thead>
* <tr>
* <th>Target</th>
* <th>Gesture</th>
* <th>Action</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td rowspan="5">Data Item</td>
* <td rowspan="2"><kbd>Tap</kbd></td>
* <td>Select when <code class="prettyprint">selectionMode</code> is enabled.</td>
* </tr>
* <tr>
* <td>Drill when <code class="prettyprint">drilling</code> is enabled and <code class="prettyprint">selectionMode</code> is <code class="prettyprint">none</code>.</td>
* </tr>
* <tr>
* <td><kbd>Double Tap</kbd></td>
* <td>Drill when <code class="prettyprint">drilling</code> is enabled and <code class="prettyprint">selectionMode</code> is enabled.</td>
* </tr>
* <tr>
* <td rowspan="2"><kbd>Press & Hold</kbd></td>
* <td>Display tooltip.</td>
* </tr>
* <tr>
* <td>Display context menu on release.</td>
* </tr>
* <tr>
* <td>Categorical Axis Item</td>
* <td><kbd>Tap</kbd></td>
* <td>Drill when <code class="prettyprint">drilling</code> is enabled.</td>
* </tr>
* <tr>
* <td rowspan="2">Legend Item</td>
* <td rowspan="2"><kbd>Tap</kbd></td>
* <td>Drill when <code class="prettyprint">drilling</code> is enabled.</td>
* </tr>
* <tr>
* <td>Filter when <code class="prettyprint">hideAndShowBehavior</code> is enabled.</td>
* </tr>
* <tr>
* <td rowspan="4">Plot Area</td>
* <td rowspan="2"><kbd>Drag</kbd></td>
* <td>Pan when panning is enabled and toggled into that mode.</td>
* </tr>
* <tr>
* <td>Marquee select when <code class="prettyprint">selectionMode</code> is <code class="prettyprint">multiple</code> and toggled into that mode.</td>
* </tr>
* <tr>
* <td><kbd>Pinch-close</kbd></td>
* <td>Zoom out when zooming is enabled.</td>
* </tr>
* <tr>
* <td><kbd>Spread-open</kbd></td>
* <td>Zoom in when zooming is enabled.</td>
* </tr>
* </tbody>
* </table>
* @ojfragment touchDoc - Used in touch gesture section of classdesc, and standalone gesture doc
* @memberof oj.ojChart
*/
/**
* <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 and selection to previous data item.</td>
* </tr>
* <tr>
* <td><kbd>DownArrow</kbd></td>
* <td>Move focus and selection to next data item.</td>
* </tr>
* <tr>
* <td><kbd>LeftArrow</kbd></td>
* <td>Move focus and selection to previous data item (on left).</td>
* </tr>
* <tr>
* <td><kbd>RightArrow</kbd></td>
* <td>Move focus and selection to next data item (on right).</td>
* </tr>
* <tr>
* <td><kbd>Shift + UpArrow</kbd></td>
* <td>Move focus and multi-select previous data item.</td>
* </tr>
* <tr>
* <td><kbd>Shift + DownArrow</kbd></td>
* <td>Move focus and multi-select next data item.</td>
* </tr>
* <tr>
* <td><kbd>Shift + LeftArrow</kbd></td>
* <td>Move focus and multi-select previous data item (on left).</td>
* </tr>
* <tr>
* <td><kbd>Shift + RightArrow</kbd></td>
* <td>Move focus and multi-select next data item (on right).</td>
* </tr>
* <tr>
* <td><kbd>Ctrl + UpArrow</kbd></td>
* <td>Move focus to previous data item, without changing the current selection.</td>
* </tr>
* <tr>
* <td><kbd>Ctrl + DownArrow</kbd></td>
* <td>Move focus to next data item, without changing the current selection.</td>
* </tr>
* <tr>
* <td><kbd>Ctrl + LeftArrow</kbd></td>
* <td>Move focus to previous data item (on left), without changing the current selection.</td>
* </tr>
* <tr>
* <td><kbd>Ctrl + RightArrow</kbd></td>
* <td>Move focus to next data item (on right), without changing the current selection.</td>
* </tr>
* <tr>
* <td><kbd>Ctrl + Spacebar</kbd></td>
* <td>Multi-select data item with focus.</td>
* </tr>
* <tr>
* <td><kbd>=</kbd> or <kbd>+</kbd></td>
* <td>Zoom in one level if zooming is enabled.</td>
* </tr>
* <tr>
* <td><kbd>-</kbd> or <kbd>_</kbd></td>
* <td>Zoom out one level if zooming is enabled.</td>
* </tr>
* <tr>
* <td><kbd>PageUp</kbd></td>
* <td>Pan up if scrolling is enabled.</td>
* </tr>
* <tr>
* <td><kbd>PageDown</kbd></td>
* <td>Pan down if scrolling is enabled.</td>
* </tr>
* <tr>
* <td><kbd>Shift + PageUp</kbd></td>
* <td>Pan left in left-to-right locales. Pan right in right-to-left locales.</td>
* </tr>
* <tr>
* <td><kbd>Shift + PageDown</kbd></td>
* <td>Pan right in left-to-right locales. Pan left in right-to-left locales.</td>
* </tr>
* </tbody>
* </table>
* @ojfragment keyboardDoc - Used in keyboard section of classdesc, and standalone gesture doc
* @memberof oj.ojChart
*/
// SubId Locators **************************************************************
/**
* <p>Sub-ID for chart data items indexed by series and group indices. The group index is not required for pie and
* funnel charts.</p>
*
* @property {number} seriesIndex
* @property {number} itemIndex
*
* @ojsubid oj-chart-item
* @memberof oj.ojChart
*
* @example <caption>Get the data item from the first series and second group:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-item', 'seriesIndex': 0, 'itemIndex': 1} );
*/
/**
* <p>Sub-ID for a legend item that represents the series with the specified index.</p>
*
* <p>See the <a href="#getNodeBySubId">getNodeBySubId</a> and
* <a href="#getSubIdByNode">getSubIdByNode</a> methods for details.</p>
*
* @property {number} index
*
* @ojsubid oj-chart-series
* @memberof oj.ojChart
*
* @example <caption>Get the legend item that represents the first series:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-series', 'index': 0} );
*/
/**
* <p>Sub-ID for a categorical axis label that represents the group with the specified index.</p>
*
* @property {Array} indexPath The array of indices corresponding to the position of the group in the options array.
*
* @ojsubid oj-chart-group
* @memberof oj.ojChart
* @instance
*
* @example <caption>Get the categorical axis label that represents the first group:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-group', 'indexPath': [0]} );
*/
/**
* <p>Sub-ID for the title of the specified axis.</p>
*
* @property {string} axis <code class="prettyprint">xAxis</code>, <code class="prettyprint">yAxis</code>, or <code class="prettyprint">y2Axis</code>
*
* @ojsubid oj-chart-axis-title
* @memberof oj.ojChart
*
* @example <caption>Get the title for the x-axis:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-axis-title', 'axis': 'xAxis'} );
*/
/**
* <p>Sub-ID for the reference object of the specified axis with the given index.</p>
*
* @property {string} axis <code class="prettyprint">xAxis</code>, <code class="prettyprint">yAxis</code>, or <code class="prettyprint">y2Axis</code>
* @property {number} index The index of the reference object for the specified axis.
*
* @ojsubid oj-chart-reference-object
* @memberof oj.ojChart
*
* @example <caption>Get the first reference object of the y-axis:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-reference-object', 'axis': 'yAxis', 'index': 0} );
*/
/**
* <p>Sub-ID for the the chart tooltip.</p>
*
* @ojsubid oj-chart-tooltip
* @memberof oj.ojChart
*
* @example <caption>Get the tooltip object of the chart, if displayed:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-chart-tooltip'} );
*/
/**
* <p>Sub-ID for a legend item indexed by its position in its parent section's
* item array and its parent's sectionIndex.</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.ojChart
*
* @example <caption>Get the first legend item from the first legend section:</caption>
* var nodes = $( ".selector" ).ojChart( "getNodeBySubId", {'subId': 'oj-legend-item', sectionIndexPath: [0], itemIndex: 1} );
*/
// Node Context Objects ********************************************************
/**
* <p>Context for chart data items indexed by series and group indices.</p>
*
* @property {number} seriesIndex
* @property {number} itemIndex
*
* @ojnodecontext oj-chart-item
* @memberof oj.ojChart
*/
/**
* <p>Context for a legend item that represents the series with the specified index.</p>
*
* @property {number} index
*
* @ojnodecontext oj-chart-series
* @memberof oj.ojChart
*/
/**
* <p>Context for a categorical axis label that represents the group with the specified index.</p>
*
* @property {Array} indexPath The array of indices corresponding to the position of the group in the options array.
*
* @ojnodecontext oj-chart-group
* @memberof oj.ojChart
*/
/**
* <p>Context for the title of the specified axis.</p>
*
* @property {string} axis <code class="prettyprint">xAxis</code>, <code class="prettyprint">yAxis</code>, or <code class="prettyprint">y2Axis</code>
*
* @ojnodecontext oj-chart-axis-title
* @memberof oj.ojChart
*/
/**
* <p>Context for the reference object of the specified axis with the given index.</p>
*
* @property {string} axis <code class="prettyprint">xAxis</code>, <code class="prettyprint">yAxis</code>, or <code class="prettyprint">y2Axis</code>
* @property {number} index The index of the reference object for the specified axis.
*
* @ojnodecontext oj-chart-reference-object
* @memberof oj.ojChart
*/
/**
* <p>Context for a legend item indexed by its position in its parent section's
* item array and its parent's sectionIndex.</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.ojChart
*/
Source: src/main/javascript/oracle/oj/ojchart/ojchart_doc.js
Oracle® JavaScript Extension Toolkit (JET)
1.1.2
E65298-01