Blame view

src/main/webapp/js/arcgis_js_api/esri/widgets/interfaces.jsdoc 1.91 KB
caiyongsong committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
/**
 * @module esri/widgets/interfaces
 */

//--------------------------------------------------------------------------
//
//  Virtual jsdoc
//
//--------------------------------------------------------------------------

/**
 * @name Axes
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {number} [x]
 * @property {number} [y]
 * @property {number} [z]
 */

/**
 * @name SearchResult
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {module:esri/geometry/Extent} extent
 * @property {module:esri/Graphic} feature
 * @property {string} name
 */

/**
 * @name SearchResults
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {module:esri/widgets/interfaces/SearchResult[]} results
 * @property {object} source
 * @property {number} sourceIndex
 */

/**
 * @name SuggestResult
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {string} text
 * @property {string} magicKey
 * @property {number} sourceIndex
 */

/**
 * @name SuggestResults
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {module:esri/widgets/interfaces/SuggestResult[]} results
 * @property {object} source
 * @property {number} sourceIndex
 */

/**
 * @name Results
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {number} activeSourceIndex
 * @property {string} searchTerm
 * @property {number} numResults
 * @property {number} numErrors
 * @property {Error[]} errors
 * @property {module:esri/widgets/interfaces/SearchResults | module:esri/widgets/interfaces/SuggestResults} results
 */

/**
 * @name ScaleBarProperties
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {number} length
 * @property {number} value
 * @property {string} unit
 */

/**
 * @name Bounds
 * @memberof module:esri/widgets/interfaces
 * @type {object}
 *
 * @property {number} max
 * @property {number} min
 */