Source: src/main/javascript/oracle/oj/ojthematicmap/ojthematicmap_doc.js

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

/**
 * <table class="keyboard-table">
 *   <thead>
 *     <tr>
 *       <th>Target</th>
 *       <th>Gesture</th>
 *       <th>Action</th>
 *     </tr>
 *   </thead>
 *   <tbody>
 *     <tr>
 *       <td rowspan="3">Data Item</td>
 *       <td><kbd>Tap</kbd></td>
 *       <td>Select when <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 rowspan="3">Component</td>
 *       <td><kbd>Drag</kbd></td>
 *       <td>Pan when <code class="prettyprint">panning</code> is <code class="prettyprint">auto</code>.</td>
 *     </tr>
 *     <tr>
 *       <td><kbd>Pinch-close</kbd></td>
 *       <td>Zoom out when <code class="prettyprint">zooming</code> is <code class="prettyprint">auto</code>.</td>
 *     </tr>
 *     <tr>
 *       <td><kbd>Spread-open</kbd></td>
 *       <td>Zoom in when <code class="prettyprint">zooming</code> is <code class="prettyprint">auto</code>.</td>
 *     </tr>
 *   </tbody>
 * </table>
 * @ojfragment touchDoc - Used in touch gesture section of classdesc, and standalone gesture doc
 * @memberof oj.ojThematicMap
 */

/**
 *<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 map and then to next component.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + Tab</kbd></td>
 *     <td>Move focus to map and then to previous component.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>= or +</kbd></td>
 *     <td>Zoom in one level if zooming is enabled.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>- or _</kbd></td>
 *     <td>Zoom out one level if zooming is enabled.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>0</kbd></td>
 *     <td>Zoom to fit map if zooming is enabled.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + Alt + 0</kbd></td>
 *     <td>Zoom to fit region with focus.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + 0</kbd></td>
 *     <td>Zoom to fit selected regions.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + Shift + 0</kbd></td>
 *     <td>Reset map.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>PageUp</kbd></td>
 *     <td>Pan up.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>PageDown</kbd></td>
 *     <td>Pan down.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + PageUp</kbd></td>
 *     <td>Pans left in left to right locales.  Pans right in right to left locales.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + PageDown</kbd></td>
 *     <td>Pans right in left to right locales.  Pans left in right to left locales.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>LeftArrow</kbd></td>
 *     <td>Move focus and selection to nearest base map region or marker to the left in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>RightArrow</kbd></td>
 *     <td>Move focus and selection to nearest base map region or marker to the right in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>UpArrow</kbd></td>
 *     <td>Move focus and selection to nearest base map region or marker above in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>DownArrow</kbd></td>
 *     <td>Move focus and selection to nearest base map region or marker below in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + LeftArrow</kbd></td>
 *     <td>Move focus and multi-select nearest base map region or marker to the left in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + RightArrow</kbd></td>
 *     <td>Move focus and multi-select nearest base map region or marker to the right in same data layer</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + UpArrow</kbd></td>
 *     <td>Move focus and multi-select nearest base map region or marker above in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + DownArrow</kbd></td>
 *     <td>Move focus and multi-select nearest base map region or marker below in same data layer.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + LeftArrow</kbd></td>
 *     <td>Move focus to nearest base map region or marker to the left in same data layer, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + RightArrow</kbd></td>
 *     <td>Move focus to nearest base map region or marker to the right in same data layer, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + UpArrow</kbd></td>
 *     <td>Move focus to nearest base map region or marker above in same data layer, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + DownArrow</kbd></td>
 *     <td>Move focus to nearest base map region or marker below in same data layer, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>]</kbd></td>
 *     <td>Move focus and selection to nearest marker in the next data layer above.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>[</kbd></td>
 *     <td>Move focus and selection to nearest base map region or marker in the next data layer below.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + ]</kbd></td>
 *     <td>Move focus to nearest marker in the next data layer above and multi-select.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Shift + [</kbd></td>
 *     <td>Move focus to nearest base map region or marker in the next data layer below and multi-select.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + ]</kbd></td>
 *     <td>Move focus to nearest marker in the next data layer above, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + [</kbd></td>
 *     <td>Move focus to nearest base map region or marker in the next data layer below, without changing the current selection.</td>
 *  </tr>
 *  <tr>
 *     <td><kbd>Ctrl + Spacebar</kbd></td>
 *     <td>Multi-select base map region or marker with focus.</td>
 *  </tr>
 *  </tbody>
 *</table>
 * @ojfragment keyboardDoc - Used in keyboard section of classdesc, and standalone gesture doc
 * @memberof oj.ojThematicMap
 */

// SubId Locators **************************************************************

/**
 * <p>Sub-ID for an area in the specified data layer.</p>
 *
 * @property {string} dataLayer The id of the data layer.
 * @property {number} index The index of the area within the specified data layer.
 *
 * @ojsubid oj-thematicmap-area
 * @memberof oj.ojThematicMap
 *
 * @example <caption>Get the first area in the data layer with id 'states':</caption>
 * var nodes = $( ".selector" ).ojThematicMap( "getNodeBySubId", {'subId': 'oj-thematicmap-area', 'dataLayer': 'states', 'index' : 0} );
 */

/**
 * <p>Sub-ID for a marker in the specified data layer.</p>
 *
 * @property {string} dataLayer The id of the data layer.
 * @property {number} index The index of the marker within the specified data layer.
 *
 * @ojsubid oj-thematicmap-marker
 * @memberof oj.ojThematicMap
 *
 * @example <caption>Get the first marker in the data layer with id 'states':</caption>
 * var nodes = $( ".selector" ).ojThematicMap( "getNodeBySubId", {'subId': 'oj-thematicmap-marker', 'dataLayer': 'states', 'index' : 0} );
 */

/**
 * <p>Sub-ID for the the thematic map tooltip.</p>
 *
 * @ojsubid oj-thematicmap-tooltip
 * @memberof oj.ojThematicMap
 *
 * @example <caption>Get the tooltip object of the thematic map, if displayed:</caption>
 * var nodes = $( ".selector" ).ojThematicMap( "getNodeBySubId", {'subId': 'oj-thematicmap-tooltip'} );
 */

// Node Context Objects ********************************************************

/**
 * <p>Context for an area in the specified data layer.</p>
 *
 * @property {string} dataLayer The id of the data layer.
 * @property {number} index The index of the area within the specified data layer.
 *
 * @ojnodecontext oj-thematicmap-area
 * @memberof oj.ojThematicMap
 */

/**
 * <p>Context for a marker in the specified data layer.</p>
 *
 * @property {string} dataLayer The id of the data layer.
 * @property {number} index The index of the marker within the specified data layer.
 *
 * @ojnodecontext oj-thematicmap-marker
 * @memberof oj.ojThematicMap
 */