GridImageryProvider.html 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>GridImageryProvider - Cesium Documentation</title>
  8. <!--[if lt IE 9]>
  9. <script src="javascript/html5.js"></script>
  10. <![endif]-->
  11. <link href="styles/jsdoc-default.css" rel="stylesheet">
  12. <link href="styles/prism.css" rel="stylesheet">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">
  17. <a href="index.html"><img src="images/CesiumLogo.png" class="cesiumLogo"></a>
  18. GridImageryProvider
  19. <div class="titleCenterer"></div>
  20. </h1>
  21. <section>
  22. <header>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <dt>
  27. <div class="nameContainer">
  28. <h4 class="name" id="GridImageryProvider">
  29. <a href="#GridImageryProvider" class="doc-link"></a>
  30. new Cesium.GridImageryProvider<span class="signature">(<span class="optional">options</span>, <span class="optional">backgroundColor</span>)</span>
  31. <div class="source-link rightLinks">
  32. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L45">Scene/GridImageryProvider.js 45</a>
  33. </div>
  34. </h4>
  35. </div>
  36. </dt>
  37. <dd>
  38. <div class="description">
  39. An <a href="ImageryProvider.html"><code>ImageryProvider</code></a> that draws a wireframe grid on every tile with controllable background and glow. May be useful for custom rendering effects or debugging terrain.
  40. </div>
  41. <table class="params">
  42. <thead>
  43. <tr>
  44. <th>Name</th>
  45. <th>Type</th>
  46. <th>Default</th>
  47. <th class="last">Description</th>
  48. </tr>
  49. </thead>
  50. <tbody>
  51. <tr>
  52. <td class="name"><code>options</code></td>
  53. <td class="type">
  54. <span class="param-type">Object</span>
  55. </td>
  56. <td class="default">
  57. </td>
  58. <td class="description last">
  59. <span class="optional">optional</span>
  60. Object with the following properties:
  61. <table class="params">
  62. <thead>
  63. <tr>
  64. <th>Name</th>
  65. <th>Type</th>
  66. <th>Default</th>
  67. <th class="last">Description</th>
  68. </tr>
  69. </thead>
  70. <tbody>
  71. <tr>
  72. <td class="name"><code>tilingScheme</code></td>
  73. <td class="type">
  74. <span class="param-type"><a href="TilingScheme.html">TilingScheme</a></span>
  75. </td>
  76. <td class="default">
  77. <code class="language-javascript">new GeographicTilingScheme()</code>
  78. </td>
  79. <td class="description last">
  80. <span class="optional">optional</span>
  81. The tiling scheme for which to draw tiles.</td>
  82. </tr>
  83. <tr>
  84. <td class="name"><code>ellipsoid</code></td>
  85. <td class="type">
  86. <span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
  87. </td>
  88. <td class="default">
  89. </td>
  90. <td class="description last">
  91. <span class="optional">optional</span>
  92. The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.</td>
  93. </tr>
  94. <tr>
  95. <td class="name"><code>cells</code></td>
  96. <td class="type">
  97. <span class="param-type">Number</span>
  98. </td>
  99. <td class="default">
  100. <code class="language-javascript">8</code>
  101. </td>
  102. <td class="description last">
  103. <span class="optional">optional</span>
  104. The number of grids cells.</td>
  105. </tr>
  106. <tr>
  107. <td class="name"><code>color</code></td>
  108. <td class="type">
  109. <span class="param-type"><a href="Color.html">Color</a></span>
  110. </td>
  111. <td class="default">
  112. <code class="language-javascript">Color(1.0, 1.0, 1.0, 0.4)</code>
  113. </td>
  114. <td class="description last">
  115. <span class="optional">optional</span>
  116. The color to draw grid lines.</td>
  117. </tr>
  118. <tr>
  119. <td class="name"><code>glowColor</code></td>
  120. <td class="type">
  121. <span class="param-type"><a href="Color.html">Color</a></span>
  122. </td>
  123. <td class="default">
  124. <code class="language-javascript">Color(0.0, 1.0, 0.0, 0.05)</code>
  125. </td>
  126. <td class="description last">
  127. <span class="optional">optional</span>
  128. The color to draw glow for grid lines.</td>
  129. </tr>
  130. <tr>
  131. <td class="name"><code>glowWidth</code></td>
  132. <td class="type">
  133. <span class="param-type">Number</span>
  134. </td>
  135. <td class="default">
  136. <code class="language-javascript">6</code>
  137. </td>
  138. <td class="description last">
  139. <span class="optional">optional</span>
  140. The width of lines used for rendering the line glow effect.</td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. </td>
  145. </tr>
  146. <tr>
  147. <td class="name"><code>backgroundColor</code></td>
  148. <td class="type">
  149. <span class="param-type"><a href="Color.html">Color</a></span>
  150. </td>
  151. <td class="default">
  152. <code class="language-javascript">Color(0.0, 0.5, 0.0, 0.2)</code>
  153. </td>
  154. <td class="description last">
  155. <span class="optional">optional</span>
  156. Background fill color.</td>
  157. </tr>
  158. <tr>
  159. <td class="name"><code>options.tileWidth</code></td>
  160. <td class="type">
  161. <span class="param-type">Number</span>
  162. </td>
  163. <td class="default">
  164. <code class="language-javascript">256</code>
  165. </td>
  166. <td class="description last">
  167. <span class="optional">optional</span>
  168. The width of the tile for level-of-detail selection purposes.</td>
  169. </tr>
  170. <tr>
  171. <td class="name"><code>options.tileHeight</code></td>
  172. <td class="type">
  173. <span class="param-type">Number</span>
  174. </td>
  175. <td class="default">
  176. <code class="language-javascript">256</code>
  177. </td>
  178. <td class="description last">
  179. <span class="optional">optional</span>
  180. The height of the tile for level-of-detail selection purposes.</td>
  181. </tr>
  182. <tr>
  183. <td class="name"><code>options.canvasSize</code></td>
  184. <td class="type">
  185. <span class="param-type">Number</span>
  186. </td>
  187. <td class="default">
  188. <code class="language-javascript">256</code>
  189. </td>
  190. <td class="description last">
  191. <span class="optional">optional</span>
  192. The size of the canvas used for rendering.</td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <dl class="details">
  197. </dl>
  198. </dd>
  199. </div>
  200. <h3 class="subsection-title">Members</h3>
  201. <dl>
  202. <dt>
  203. <div class="nameContainer">
  204. <h4 class="name" id="credit">
  205. <a href="#credit" class="doc-link"></a>
  206. <span class="type-signature attribute-readonly">readonly</span>credit<span class="type-signature"> : <a href="Credit.html">Credit</a></span>
  207. <div class="source-link rightLinks">
  208. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L220">Scene/GridImageryProvider.js 220</a>
  209. </div>
  210. </h4>
  211. </div>
  212. </dt>
  213. <dd>
  214. <div class="description">
  215. Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  216. </div>
  217. <dl class="details">
  218. </dl>
  219. </dd>
  220. <dt>
  221. <div class="nameContainer">
  222. <h4 class="name" id="errorEvent">
  223. <a href="#errorEvent" class="doc-link"></a>
  224. <span class="type-signature attribute-readonly">readonly</span>errorEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
  225. <div class="source-link rightLinks">
  226. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L183">Scene/GridImageryProvider.js 183</a>
  227. </div>
  228. </h4>
  229. </div>
  230. </dt>
  231. <dd>
  232. <div class="description">
  233. Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of <a href="TileProviderError.html"><code>TileProviderError</code></a>.
  234. </div>
  235. <dl class="details">
  236. </dl>
  237. </dd>
  238. <dt>
  239. <div class="nameContainer">
  240. <h4 class="name" id="hasAlphaChannel">
  241. <a href="#hasAlphaChannel" class="doc-link"></a>
  242. <span class="type-signature attribute-readonly">readonly</span>hasAlphaChannel<span class="type-signature"> : Boolean</span>
  243. <div class="source-link rightLinks">
  244. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L236">Scene/GridImageryProvider.js 236</a>
  245. </div>
  246. </h4>
  247. </div>
  248. </dt>
  249. <dd>
  250. <div class="description">
  251. Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced.
  252. </div>
  253. <dl class="details">
  254. </dl>
  255. </dd>
  256. <dt>
  257. <div class="nameContainer">
  258. <h4 class="name" id="maximumLevel">
  259. <a href="#maximumLevel" class="doc-link"></a>
  260. <span class="type-signature attribute-readonly">readonly</span>maximumLevel<span class="type-signature"> : Number</span>
  261. <div class="source-link rightLinks">
  262. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L115">Scene/GridImageryProvider.js 115</a>
  263. </div>
  264. </h4>
  265. </div>
  266. </dt>
  267. <dd>
  268. <div class="description">
  269. Gets the maximum level-of-detail that can be requested. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  270. </div>
  271. <dl class="details">
  272. </dl>
  273. </dd>
  274. <dt>
  275. <div class="nameContainer">
  276. <h4 class="name" id="minimumLevel">
  277. <a href="#minimumLevel" class="doc-link"></a>
  278. <span class="type-signature attribute-readonly">readonly</span>minimumLevel<span class="type-signature"> : Number</span>
  279. <div class="source-link rightLinks">
  280. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L128">Scene/GridImageryProvider.js 128</a>
  281. </div>
  282. </h4>
  283. </div>
  284. </dt>
  285. <dd>
  286. <div class="description">
  287. Gets the minimum level-of-detail that can be requested. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  288. </div>
  289. <dl class="details">
  290. </dl>
  291. </dd>
  292. <dt>
  293. <div class="nameContainer">
  294. <h4 class="name" id="proxy">
  295. <a href="#proxy" class="doc-link"></a>
  296. <span class="type-signature attribute-readonly">readonly</span>proxy<span class="type-signature"> : Proxy</span>
  297. <div class="source-link rightLinks">
  298. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L76">Scene/GridImageryProvider.js 76</a>
  299. </div>
  300. </h4>
  301. </div>
  302. </dt>
  303. <dd>
  304. <div class="description">
  305. Gets the proxy used by this provider.
  306. </div>
  307. <dl class="details">
  308. </dl>
  309. </dd>
  310. <dt>
  311. <div class="nameContainer">
  312. <h4 class="name" id="ready">
  313. <a href="#ready" class="doc-link"></a>
  314. <span class="type-signature attribute-readonly">readonly</span>ready<span class="type-signature"> : Boolean</span>
  315. <div class="source-link rightLinks">
  316. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L195">Scene/GridImageryProvider.js 195</a>
  317. </div>
  318. </h4>
  319. </div>
  320. </dt>
  321. <dd>
  322. <div class="description">
  323. Gets a value indicating whether or not the provider is ready for use.
  324. </div>
  325. <dl class="details">
  326. </dl>
  327. </dd>
  328. <dt>
  329. <div class="nameContainer">
  330. <h4 class="name" id="readyPromise">
  331. <a href="#readyPromise" class="doc-link"></a>
  332. <span class="type-signature attribute-readonly">readonly</span>readyPromise<span class="type-signature"> : Promise.&lt;Boolean></span>
  333. <div class="source-link rightLinks">
  334. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L207">Scene/GridImageryProvider.js 207</a>
  335. </div>
  336. </h4>
  337. </div>
  338. </dt>
  339. <dd>
  340. <div class="description">
  341. Gets a promise that resolves to true when the provider is ready for use.
  342. </div>
  343. <dl class="details">
  344. </dl>
  345. </dd>
  346. <dt>
  347. <div class="nameContainer">
  348. <h4 class="name" id="rectangle">
  349. <a href="#rectangle" class="doc-link"></a>
  350. <span class="type-signature attribute-readonly">readonly</span>rectangle<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
  351. <div class="source-link rightLinks">
  352. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L154">Scene/GridImageryProvider.js 154</a>
  353. </div>
  354. </h4>
  355. </div>
  356. </dt>
  357. <dd>
  358. <div class="description">
  359. Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  360. </div>
  361. <dl class="details">
  362. </dl>
  363. </dd>
  364. <dt>
  365. <div class="nameContainer">
  366. <h4 class="name" id="tileDiscardPolicy">
  367. <a href="#tileDiscardPolicy" class="doc-link"></a>
  368. <span class="type-signature attribute-readonly">readonly</span>tileDiscardPolicy<span class="type-signature"> : <a href="TileDiscardPolicy.html">TileDiscardPolicy</a></span>
  369. <div class="source-link rightLinks">
  370. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L169">Scene/GridImageryProvider.js 169</a>
  371. </div>
  372. </h4>
  373. </div>
  374. </dt>
  375. <dd>
  376. <div class="description">
  377. Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  378. </div>
  379. <dl class="details">
  380. </dl>
  381. </dd>
  382. <dt>
  383. <div class="nameContainer">
  384. <h4 class="name" id="tileHeight">
  385. <a href="#tileHeight" class="doc-link"></a>
  386. <span class="type-signature attribute-readonly">readonly</span>tileHeight<span class="type-signature"> : Number</span>
  387. <div class="source-link rightLinks">
  388. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L102">Scene/GridImageryProvider.js 102</a>
  389. </div>
  390. </h4>
  391. </div>
  392. </dt>
  393. <dd>
  394. <div class="description">
  395. Gets the height of each tile, in pixels. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  396. </div>
  397. <dl class="details">
  398. </dl>
  399. </dd>
  400. <dt>
  401. <div class="nameContainer">
  402. <h4 class="name" id="tileWidth">
  403. <a href="#tileWidth" class="doc-link"></a>
  404. <span class="type-signature attribute-readonly">readonly</span>tileWidth<span class="type-signature"> : Number</span>
  405. <div class="source-link rightLinks">
  406. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L89">Scene/GridImageryProvider.js 89</a>
  407. </div>
  408. </h4>
  409. </div>
  410. </dt>
  411. <dd>
  412. <div class="description">
  413. Gets the width of each tile, in pixels. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  414. </div>
  415. <dl class="details">
  416. </dl>
  417. </dd>
  418. <dt>
  419. <div class="nameContainer">
  420. <h4 class="name" id="tilingScheme">
  421. <a href="#tilingScheme" class="doc-link"></a>
  422. <span class="type-signature attribute-readonly">readonly</span>tilingScheme<span class="type-signature"> : <a href="TilingScheme.html">TilingScheme</a></span>
  423. <div class="source-link rightLinks">
  424. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L141">Scene/GridImageryProvider.js 141</a>
  425. </div>
  426. </h4>
  427. </div>
  428. </dt>
  429. <dd>
  430. <div class="description">
  431. Gets the tiling scheme used by this provider. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  432. </div>
  433. <dl class="details">
  434. </dl>
  435. </dd>
  436. </dl>
  437. <h3 class="subsection-title">Methods</h3>
  438. <dl>
  439. <dt>
  440. <div class="nameContainer">
  441. <h4 class="name" id="_createGridCanvas">
  442. <a href="#_createGridCanvas" class="doc-link"></a>
  443. _createGridCanvas<span class="signature">()</span>
  444. <div class="source-link rightLinks">
  445. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L264">Scene/GridImageryProvider.js 264</a>
  446. </div>
  447. </h4>
  448. </div>
  449. </dt>
  450. <dd>
  451. <div class="description">
  452. Render a grid into a canvas with background and glow
  453. </div>
  454. <dl class="details">
  455. </dl>
  456. </dd>
  457. <dt>
  458. <div class="nameContainer">
  459. <h4 class="name" id="_drawGrid">
  460. <a href="#_drawGrid" class="doc-link"></a>
  461. _drawGrid<span class="signature">()</span>
  462. <div class="source-link rightLinks">
  463. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L246">Scene/GridImageryProvider.js 246</a>
  464. </div>
  465. </h4>
  466. </div>
  467. </dt>
  468. <dd>
  469. <div class="description">
  470. Draws a grid of lines into a canvas.
  471. </div>
  472. <dl class="details">
  473. </dl>
  474. </dd>
  475. <dt>
  476. <div class="nameContainer">
  477. <h4 class="name" id="getTileCredits">
  478. <a href="#getTileCredits" class="doc-link"></a>
  479. getTileCredits<span class="signature">(x, y, level)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Credit.html">Credit</a>></span>
  480. <div class="source-link rightLinks">
  481. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L313">Scene/GridImageryProvider.js 313</a>
  482. </div>
  483. </h4>
  484. </div>
  485. </dt>
  486. <dd>
  487. <div class="description">
  488. Gets the credits to be displayed when a given tile is displayed.
  489. </div>
  490. <table class="params">
  491. <thead>
  492. <tr>
  493. <th>Name</th>
  494. <th>Type</th>
  495. <th class="last">Description</th>
  496. </tr>
  497. </thead>
  498. <tbody>
  499. <tr>
  500. <td class="name"><code>x</code></td>
  501. <td class="type">
  502. <span class="param-type">Number</span>
  503. </td>
  504. <td class="description last">
  505. The tile X coordinate.</td>
  506. </tr>
  507. <tr>
  508. <td class="name"><code>y</code></td>
  509. <td class="type">
  510. <span class="param-type">Number</span>
  511. </td>
  512. <td class="description last">
  513. The tile Y coordinate.</td>
  514. </tr>
  515. <tr>
  516. <td class="name"><code>level</code></td>
  517. <td class="type">
  518. <span class="param-type">Number</span>
  519. </td>
  520. <td class="description last">
  521. The tile level;</td>
  522. </tr>
  523. </tbody>
  524. </table>
  525. <h5>Returns:</h5>
  526. <div class="param-desc">
  527. The credits to be displayed when the tile is displayed.
  528. </div>
  529. <h5>Throws:</h5>
  530. <ul>
  531. <li>
  532. <div class="param-desc">
  533. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  534. : <code>getTileCredits</code> must not be called before the imagery provider is ready.
  535. </div>
  536. </li>
  537. </ul>
  538. <dl class="details">
  539. </dl>
  540. </dd>
  541. <dt>
  542. <div class="nameContainer">
  543. <h4 class="name" id="pickFeatures">
  544. <a href="#pickFeatures" class="doc-link"></a>
  545. pickFeatures<span class="signature">(x, y, level, longitude, latitude)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Array.&lt;<a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a>>>|undefined</span>
  546. <div class="source-link rightLinks">
  547. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L347">Scene/GridImageryProvider.js 347</a>
  548. </div>
  549. </h4>
  550. </div>
  551. </dt>
  552. <dd>
  553. <div class="description">
  554. Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
  555. </div>
  556. <table class="params">
  557. <thead>
  558. <tr>
  559. <th>Name</th>
  560. <th>Type</th>
  561. <th class="last">Description</th>
  562. </tr>
  563. </thead>
  564. <tbody>
  565. <tr>
  566. <td class="name"><code>x</code></td>
  567. <td class="type">
  568. <span class="param-type">Number</span>
  569. </td>
  570. <td class="description last">
  571. The tile X coordinate.</td>
  572. </tr>
  573. <tr>
  574. <td class="name"><code>y</code></td>
  575. <td class="type">
  576. <span class="param-type">Number</span>
  577. </td>
  578. <td class="description last">
  579. The tile Y coordinate.</td>
  580. </tr>
  581. <tr>
  582. <td class="name"><code>level</code></td>
  583. <td class="type">
  584. <span class="param-type">Number</span>
  585. </td>
  586. <td class="description last">
  587. The tile level.</td>
  588. </tr>
  589. <tr>
  590. <td class="name"><code>longitude</code></td>
  591. <td class="type">
  592. <span class="param-type">Number</span>
  593. </td>
  594. <td class="description last">
  595. The longitude at which to pick features.</td>
  596. </tr>
  597. <tr>
  598. <td class="name"><code>latitude</code></td>
  599. <td class="type">
  600. <span class="param-type">Number</span>
  601. </td>
  602. <td class="description last">
  603. The latitude at which to pick features.</td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. <h5>Returns:</h5>
  608. <div class="param-desc">
  609. A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of <a href="ImageryLayerFeatureInfo.html"><code>ImageryLayerFeatureInfo</code></a> instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.
  610. </div>
  611. <dl class="details">
  612. </dl>
  613. </dd>
  614. <dt>
  615. <div class="nameContainer">
  616. <h4 class="name" id="requestImage">
  617. <a href="#requestImage" class="doc-link"></a>
  618. requestImage<span class="signature">(x, y, level)</span> &rarr; <span class="type-signature returnType">Promise.&lt;(Image|Canvas)>|undefined</span>
  619. <div class="source-link rightLinks">
  620. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/GridImageryProvider.js#L329">Scene/GridImageryProvider.js 329</a>
  621. </div>
  622. </h4>
  623. </div>
  624. </dt>
  625. <dd>
  626. <div class="description">
  627. Requests the image for a given tile. This function should not be called before <a href="GridImageryProvider.html#ready"><code>GridImageryProvider#ready</code></a> returns true.
  628. </div>
  629. <table class="params">
  630. <thead>
  631. <tr>
  632. <th>Name</th>
  633. <th>Type</th>
  634. <th class="last">Description</th>
  635. </tr>
  636. </thead>
  637. <tbody>
  638. <tr>
  639. <td class="name"><code>x</code></td>
  640. <td class="type">
  641. <span class="param-type">Number</span>
  642. </td>
  643. <td class="description last">
  644. The tile X coordinate.</td>
  645. </tr>
  646. <tr>
  647. <td class="name"><code>y</code></td>
  648. <td class="type">
  649. <span class="param-type">Number</span>
  650. </td>
  651. <td class="description last">
  652. The tile Y coordinate.</td>
  653. </tr>
  654. <tr>
  655. <td class="name"><code>level</code></td>
  656. <td class="type">
  657. <span class="param-type">Number</span>
  658. </td>
  659. <td class="description last">
  660. The tile level.</td>
  661. </tr>
  662. </tbody>
  663. </table>
  664. <h5>Returns:</h5>
  665. <div class="param-desc">
  666. A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.
  667. </div>
  668. <dl class="details">
  669. </dl>
  670. </dd>
  671. </dl>
  672. </article>
  673. </section>
  674. <footer>
  675. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
  676. </footer>
  677. </div>
  678. <div class="nav">
  679. <div class="menu">
  680. <input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
  681. <ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisImageServerTerrainProvider"><a href="ArcGisImageServerTerrainProvider.html">ArcGisImageServerTerrainProvider</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="CesiumInspector"><a href="CesiumInspector.html">CesiumInspector</a></li><li data-name="CesiumInspectorViewModel"><a href="CesiumInspectorViewModel.html">CesiumInspectorViewModel</a></li><li data-name="CesiumMath"><a href="CesiumMath.html">CesiumMath</a></li><li data-name="CesiumTerrainProvider"><a href="CesiumTerrainProvider.html">CesiumTerrainProvider</a></li><li data-name="CesiumWidget"><a href="CesiumWidget.html">CesiumWidget</a></li><li data-name="CheckerboardMaterialProperty"><a href="CheckerboardMaterialProperty.html">CheckerboardMaterialProperty</a></li><li data-name="CircleGeometry"><a href="CircleGeometry.html">CircleGeometry</a></li><li data-name="CircleOutlineGeometry"><a href="CircleOutlineGeometry.html">CircleOutlineGeometry</a></li><li data-name="Clock"><a href="Clock.html">Clock</a></li><li data-name="ClockRange"><a href="ClockRange.html">ClockRange</a></li><li data-name="ClockStep"><a href="ClockStep.html">ClockStep</a></li><li data-name="ClockViewModel"><a href="ClockViewModel.html">ClockViewModel</a></li><li data-name="clone"><a href="clone.html">clone</a></li><li data-name="Color"><a href="Color.html">Color</a></li><li data-name="ColorBlendMode"><a href="ColorBlendMode.html">ColorBlendMode</a></li><li data-name="ColorGeometryInstanceAttribute"><a href="ColorGeometryInstanceAttribute.html">ColorGeometryInstanceAttribute</a></li><li data-name="ColorMaterialProperty"><a href="ColorMaterialProperty.html">ColorMaterialProperty</a></li><li data-name="combine"><a href="combine.html">combine</a></li><li data-name="Command"><a href="Command.html">Command</a></li><li data-name="ComponentDatatype"><a href="ComponentDatatype.html">ComponentDatatype</a></li><li data-name="CompositeEntityCollection"><a href="CompositeEntityCollection.html">CompositeEntityCollection</a></li><li data-name="CompositeMaterialProperty"><a href="CompositeMaterialProperty.html">CompositeMaterialProperty</a></li><li data-name="CompositePositionProperty"><a href="CompositePositionProperty.html">CompositePositionProperty</a></li><li data-name="CompositeProperty"><a href="CompositeProperty.html">CompositeProperty</a></li><li data-name="ConstantPositionProperty"><a href="ConstantPositionProperty.html">ConstantPositionProperty</a></li><li data-name="ConstantProperty"><a href="ConstantProperty.html">ConstantProperty</a></li><li data-name="CornerType"><a href="CornerType.html">CornerType</a></li><li data-name="CorridorGeometry"><a href="CorridorGeometry.html">CorridorGeometry</a></li><li data-name="CorridorGeometryUpdater"><a href="CorridorGeometryUpdater.html">CorridorGeometryUpdater</a></li><li data-name="CorridorGraphics"><a href="CorridorGraphics.html">CorridorGraphics</a></li><li data-name="CorridorOutlineGeometry"><a href="CorridorOutlineGeometry.html">CorridorOutlineGeometry</a></li><li data-name="createCommand"><a href="createCommand.html">createCommand</a></li><li data-name="createGuid"><a href="createGuid.html">createGuid</a></li><li data-name="createOpenStreetMapImageryProvider"><a href="createOpenStreetMapImageryProvider.html">createOpenStreetMapImageryProvider</a></li><li data-name="createTangentSpaceDebugPrimitive"><a href="createTangentSpaceDebugPrimitive.html">createTangentSpaceDebugPrimitive</a></li><li data-name="createTaskProcessorWorker"><a href="createTaskProcessorWorker.html">createTaskProcessorWorker</a></li><li data-name="createTileMapServiceImageryProvider"><a href="createTileMapServiceImageryProvider.html">createTileMapServiceImageryProvider</a></li><li data-name="Credit"><a href="Credit.html">Credit</a></li><li data-name="CreditDisplay"><a href="CreditDisplay.html">CreditDisplay</a></li><li data-name="CubicRealPolynomial"><a href="CubicRealPolynomial.html">CubicRealPolynomial</a></li><li data-name="CullFace"><a href="CullFace.html">CullFace</a></li><li data-name="CullingVolume"><a href="CullingVolume.html">CullingVolume</a></li><li data-name="CustomDataSource"><a href="CustomDataSource.html">CustomDataSource</a></li><li data-name="CylinderGeometry"><a href="CylinderGeometry.html">CylinderGeometry</a></li><li data-name="CylinderGeometryUpdater"><a href="CylinderGeometryUpdater.html">CylinderGeometryUpdater</a></li><li data-name="CylinderGraphics"><a href="CylinderGraphics.html">CylinderGraphics</a></li><li data-name="CylinderOutlineGeometry"><a href="CylinderOutlineGeometry.html">CylinderOutlineGeometry</a></li><li data-name="CzmlDataSource"><a href="CzmlDataSource.html">CzmlDataSource</a></li><li data-name="DataSource"><a href="DataSource.html">DataSource</a></li><li data-name="DataSourceClock"><a href="DataSourceClock.html">DataSourceClock</a></li><li data-name="DataSourceCollection"><a href="DataSourceCollection.html">DataSourceCollection</a></li><li data-name="DataSourceDisplay"><a href="DataSourceDisplay.html">DataSourceDisplay</a></li><li data-name="DebugAppearance"><a href="DebugAppearance.html">DebugAppearance</a></li><li data-name="DebugCameraPrimitive"><a href="DebugCameraPrimitive.html">DebugCameraPrimitive</a></li><li data-name="DebugModelMatrixPrimitive"><a href="DebugModelMatrixPrimitive.html">DebugModelMatrixPrimitive</a></li><li data-name="DefaultProxy"><a href="DefaultProxy.html">DefaultProxy</a></li><li data-name="defaultValue"><a href="defaultValue.html">defaultValue</a></li><li data-name="defined"><a href="defined.html">defined</a></li><li data-name="DepthFunction"><a href="DepthFunction.html">DepthFunction</a></li><li data-name="destroyObject"><a href="destroyObject.html">destroyObject</a></li><li data-name="DeveloperError"><a href="DeveloperError.html">DeveloperError</a></li><li data-name="DiscardMissingTileImagePolicy"><a href="DiscardMissingTileImagePolicy.html">DiscardMissingTileImagePolicy</a></li><li data-name="DistanceDisplayCondition"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></li><li data-name="DistanceDisplayConditionGeometryInstanceAttribute"><a href="DistanceDisplayConditionGeometryInstanceAttribute.html">DistanceDisplayConditionGeometryInstanceAttribute</a></li><li data-name="DynamicGeometryUpdater"><a href="DynamicGeometryUpdater.html">DynamicGeometryUpdater</a></li><li data-name="EasingFunction"><a href="EasingFunction.html">EasingFunction</a></li><li data-name="EllipseGeometry"><a href="EllipseGeometry.html">EllipseGeometry</a></li><li data-name="EllipseGeometryUpdater"><a href="EllipseGeometryUpdater.html">EllipseGeometryUpdater</a></li><li data-name="EllipseGraphics"><a href="EllipseGraphics.html">EllipseGraphics</a></li><li data-name="EllipseOutlineGeometry"><a href="EllipseOutlineGeometry.html">EllipseOutlineGeometry</a></li><li data-name="Ellipsoid"><a href="Ellipsoid.html">Ellipsoid</a></li><li data-name="EllipsoidGeodesic"><a href="EllipsoidGeodesic.html">EllipsoidGeodesic</a></li><li data-name="EllipsoidGeometry"><a href="EllipsoidGeometry.html">EllipsoidGeometry</a></li><li data-name="EllipsoidGeometryUpdater"><a href="EllipsoidGeometryUpdater.html">EllipsoidGeometryUpdater</a></li><li data-name="EllipsoidGraphics"><a href="EllipsoidGraphics.html">EllipsoidGraphics</a></li><li data-name="EllipsoidOutlineGeometry"><a href="EllipsoidOutlineGeometry.html">EllipsoidOutlineGeometry</a></li><li data-name="EllipsoidSurfaceAppearance"><a href="EllipsoidSurfaceAppearance.html">EllipsoidSurfaceAppearance</a></li><li data-name="EllipsoidTangentPlane"><a href="EllipsoidTangentPlane.html">EllipsoidTangentPlane</a></li><li data-name="EllipsoidTerrainProvider"><a href="EllipsoidTerrainProvider.html">EllipsoidTerrainProvider</a></li><li data-name="Entity"><a href="Entity.html">Entity</a></li><li data-name="EntityCluster"><a href="EntityCluster.html">EntityCluster</a></li><li data-name="EntityCollection"><a href="EntityCollection.html">EntityCollection</a></li><li data-name="EntityView"><a href="EntityView.html">EntityView</a></li><li data-name="Event"><a href="Event.html">Event</a></li><li data-name="EventHelper"><a href="EventHelper.html">EventHelper</a></li><li data-name="ExtrapolationType"><a href="ExtrapolationType.html">ExtrapolationType</a></li><li data-name="FeatureDetection"><a href="FeatureDetection.html">FeatureDetection</a></li><li data-name="Fog"><a href="Fog.html">Fog</a></li><li data-name="formatError"><a href="formatError.html">formatError</a></li><li data-name="FrameRateMonitor"><a href="FrameRateMonitor.html">FrameRateMonitor</a></li><li data-name="Fullscreen"><a href="Fullscreen.html">Fullscreen</a></li><li data-name="FullscreenButton"><a href="FullscreenButton.html">FullscreenButton</a></li><li data-name="FullscreenButtonViewModel"><a href="FullscreenButtonViewModel.html">FullscreenButtonViewModel</a></li><li data-name="Geocoder"><a href="Geocoder.html">Geocoder</a></li><li data-name="GeocoderViewModel"><a href="GeocoderViewModel.html">GeocoderViewModel</a></li><li data-name="GeographicProjection"><a href="GeographicProjection.html">GeographicProjection</a></li><li data-name="GeographicTilingScheme"><a href="GeographicTilingScheme.html">GeographicTilingScheme</a></li><li data-name="GeoJsonDataSource"><a href="GeoJsonDataSource.html">GeoJsonDataSource</a></li><li data-name="Geometry"><a href="Geometry.html">Geometry</a></li><li data-name="GeometryAttribute"><a href="GeometryAttribute.html">GeometryAttribute</a></li><li data-name="GeometryAttributes"><a href="GeometryAttributes.html">GeometryAttributes</a></li><li data-name="GeometryInstance"><a href="GeometryInstance.html">GeometryInstance</a></li><li data-name="GeometryInstanceAttribute"><a href="GeometryInstanceAttribute.html">GeometryInstanceAttribute</a></li><li data-name="GeometryPipeline"><a href="GeometryPipeline.html">GeometryPipeline</a></li><li data-name="GeometryUpdater"><a href="GeometryUpdater.html">GeometryUpdater</a></li><li data-name="GeometryVisualizer"><a href="GeometryVisualizer.html">GeometryVisualizer</a></li><li data-name="getAbsoluteUri"><a href="getAbsoluteUri.html">getAbsoluteUri</a></li><li data-name="getBaseUri"><a href="getBaseUri.html">getBaseUri</a></li><li data-name="getExtensionFromUri"><a href="getExtensionFromUri.html">getExtensionFromUri</a></li><li data-name="GetFeatureInfoFormat"><a href="GetFeatureInfoFormat.html">GetFeatureInfoFormat</a></li><li data-name="getFilenameFromUri"><a href="getFilenameFromUri.html">getFilenameFromUri</a></li><li data-name="getImagePixels"><a href="getImagePixels.html">getImagePixels</a></li><li data-name="getTimestamp"><a href="getTimestamp.html">getTimestamp</a></li><li data-name="Globe"><a href="Globe.html">Globe</a></li><li data-name="GoogleEarthImageryProvider"><a href="GoogleEarthImageryProvider.html">GoogleEarthImageryProvider</a></li><li data-name="GregorianDate"><a href="GregorianDate.html">GregorianDate</a></li><li data-name="GridImageryProvider"><a href="GridImageryProvider.html">GridImageryProvider</a></li><li data-name="GridMaterialProperty"><a href="GridMaterialProperty.html">GridMaterialProperty</a></li><li data-name="GroundPrimitive"><a href="GroundPrimitive.html">GroundPrimitive</a></li><li data-name="HeadingPitchRange"><a href="HeadingPitchRange.html">HeadingPitchRange</a></li><li data-name="HeadingPitchRoll"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></li><li data-name="HeightmapTerrainData"><a href="HeightmapTerrainData.html">HeightmapTerrainData</a></li><li data-name="HeightReference"><a href="HeightReference.html">HeightReference</a></li><li data-name="HermitePolynomialApproximation"><a href="HermitePolynomialApproximation.html">HermitePolynomialApproximation</a></li><li data-name="HermiteSpline"><a href="HermiteSpline.html">HermiteSpline</a></li><li data-name="HomeButton"><a href="HomeButton.html">HomeButton</a></li><li data-name="HomeButtonViewModel"><a href="HomeButtonViewModel.html">HomeButtonViewModel</a></li><li data-name="HorizontalOrigin"><a href="HorizontalOrigin.html">HorizontalOrigin</a></li><li data-name="ImageMaterialProperty"><a href="ImageMaterialProperty.html">ImageMaterialProperty</a></li><li data-name="ImageryLayer"><a href="ImageryLayer.html">ImageryLayer</a></li><li data-name="ImageryLayerCollection"><a href="ImageryLayerCollection.html">ImageryLayerCollection</a></li><li data-name="ImageryLayerFeatureInfo"><a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a></li><li data-name="ImageryProvider"><a href="ImageryProvider.html">ImageryProvider</a></li><li data-name="IndexDatatype"><a href="IndexDatatype.html">IndexDatatype</a></li><li data-name="InfoBox"><a href="InfoBox.html">InfoBox</a></li><li data-name="InfoBoxViewModel"><a href="InfoBoxViewModel.html">InfoBoxViewModel</a></li><li data-name="InterpolationAlgorithm"><a href="InterpolationAlgorithm.html">InterpolationAlgorithm</a></li><li data-name="Intersect"><a href="Intersect.html">Intersect</a></li><li data-name="Intersections2D"><a href="Intersections2D.html">Intersections2D</a></li><li data-name="IntersectionTests"><a href="IntersectionTests.html">IntersectionTests</a></li><li data-name="Interval"><a href="Interval.html">Interval</a></li><li data-name="isArray"><a href="isArray.html">isArray</a></li><li data-name="isLeapYear"><a href="isLeapYear.html">isLeapYear</a></li><li data-name="Iso8601"><a href="Iso8601.html">Iso8601</a></li><li data-name="JulianDate"><a href="JulianDate.html">JulianDate</a></li><li data-name="KeyboardEventModifier"><a href="KeyboardEventModifier.html">KeyboardEventModifier</a></li><li data-name="KmlDataSource"><a href="KmlDataSource.html">KmlDataSource</a></li><li data-name="KmlFeatureData"><a href="KmlFeatureData.html">KmlFeatureData</a></li><li data-name="Label"><a href="Label.html">Label</a></li><li data-name="LabelCollection"><a href="LabelCollection.html">LabelCollection</a></li><li data-name="LabelGraphics"><a href="LabelGraphics.html">LabelGraphics</a></li><li data-name="LabelStyle"><a href="LabelStyle.html">LabelStyle</a></li><li data-name="LabelVisualizer"><a href="LabelVisualizer.html">LabelVisualizer</a></li><li data-name="LagrangePolynomialApproximation"><a href="LagrangePolynomialApproximation.html">LagrangePolynomialApproximation</a></li><li data-name="LeapSecond"><a href="LeapSecond.html">LeapSecond</a></li><li data-name="LinearApproximation"><a href="LinearApproximation.html">LinearApproximation</a></li><li data-name="LinearSpline"><a href="LinearSpline.html">LinearSpline</a></li><li data-name="loadArrayBuffer"><a href="loadArrayBuffer.html">loadArrayBuffer</a></li><li data-name="loadBlob"><a href="loadBlob.html">loadBlob</a></li><li data-name="loadImage"><a href="loadImage.html">loadImage</a></li><li data-name="loadImageViaBlob"><a href="loadImageViaBlob.html">loadImageViaBlob</a></li><li data-name="loadJson"><a href="loadJson.html">loadJson</a></li><li data-name="loadJsonp"><a href="loadJsonp.html">loadJsonp</a></li><li data-name="loadText"><a href="loadText.html">loadText</a></li><li data-name="loadWithXhr"><a href="loadWithXhr.html">loadWithXhr</a></li><li data-name="loadXML"><a href="loadXML.html">loadXML</a></li><li data-name="MapboxImageryProvider"><a href="MapboxImageryProvider.html">MapboxImageryProvider</a></li><li data-name="MapMode2D"><a href="MapMode2D.html">MapMode2D</a></li><li data-name="MapProjection"><a href="MapProjection.html">MapProjection</a></li><li data-name="Material"><a href="Material.html">Material</a></li><li data-name="MaterialAppearance"><a href="MaterialAppearance.html">MaterialAppearance</a></li><li data-name="MaterialProperty"><a href="MaterialProperty.html">MaterialProperty</a></li><li data-name="Matrix2"><a href="Matrix2.html">Matrix2</a></li><li data-name="Matrix3"><a href="Matrix3.html">Matrix3</a></li><li data-name="Matrix4"><a href="Matrix4.html">Matrix4</a></li><li data-name="mergeSort"><a href="mergeSort.html">mergeSort</a></li><li data-name="Model"><a href="Model.html">Model</a></li><li data-name="ModelAnimation"><a href="ModelAnimation.html">ModelAnimation</a></li><li data-name="ModelAnimationCollection"><a href="ModelAnimationCollection.html">ModelAnimationCollection</a></li><li data-name="ModelAnimationLoop"><a href="ModelAnimationLoop.html">ModelAnimationLoop</a></li><li data-name="ModelGraphics"><a href="ModelGraphics.html">ModelGraphics</a></li><li data-name="ModelMaterial"><a href="ModelMaterial.html">ModelMaterial</a></li><li data-name="ModelMesh"><a href="ModelMesh.html">ModelMesh</a></li><li data-name="ModelNode"><a href="ModelNode.html">ModelNode</a></li><li data-name="ModelVisualizer"><a href="ModelVisualizer.html">ModelVisualizer</a></li><li data-name="Moon"><a href="Moon.html">Moon</a></li><li data-name="NavigationHelpButton"><a href="NavigationHelpButton.html">NavigationHelpButton</a></li><li data-name="NavigationHelpButtonViewModel"><a href="NavigationHelpButtonViewModel.html">NavigationHelpButtonViewModel</a></li><li data-name="NearFarScalar"><a href="NearFarScalar.html">NearFarScalar</a></li><li data-name="NeverTileDiscardPolicy"><a href="NeverTileDiscardPolicy.html">NeverTileDiscardPolicy</a></li><li data-name="NodeTransformationProperty"><a href="NodeTransformationProperty.html">NodeTransformationProperty</a></li><li data-name="objectToQuery"><a href="objectToQuery.html">objectToQuery</a></li><li data-name="Occluder"><a href="Occluder.html">Occluder</a></li><li data-name="OrientedBoundingBox"><a href="OrientedBoundingBox.html">OrientedBoundingBox</a></li><li data-name="OrthographicFrustum"><a href="OrthographicFrustum.html">OrthographicFrustum</a></li><li data-name="Packable"><a href="Packable.html">Packable</a></li><li data-name="PackableForInterpolation"><a href="PackableForInterpolation.html">PackableForInterpolation</a></li><li data-name="PathGraphics"><a href="PathGraphics.html">PathGraphics</a></li><li data-name="PathVisualizer"><a href="PathVisualizer.html">PathVisualizer</a></li><li data-name="PerformanceWatchdog"><a href="PerformanceWatchdog.html">PerformanceWatchdog</a></li><li data-name="PerformanceWatchdogViewModel"><a href="PerformanceWatchdogViewModel.html">PerformanceWatchdogViewModel</a></li><li data-name="PerInstanceColorAppearance"><a href="PerInstanceColorAppearance.html">PerInstanceColorAppearance</a></li><li data-name="PerspectiveFrustum"><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li><li data-name="PerspectiveOffCenterFrustum"><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li><li data-name="PinBuilder"><a href="PinBuilder.html">PinBuilder</a></li><li data-name="PixelFormat"><a href="PixelFormat.html">PixelFormat</a></li><li data-name="Plane"><a href="Plane.html">Plane</a></li><li data-name="PointGraphics"><a href="PointGraphics.html">PointGraphics</a></li><li data-name="pointInsideTriangle"><a href="pointInsideTriangle.html">pointInsideTriangle</a></li><li data-name="PointPrimitive"><a href="PointPrimitive.html">PointPrimitive</a></li><li data-name="PointPrimitiveCollection"><a href="PointPrimitiveCollection.html">PointPrimitiveCollection</a></li><li data-name="PointVisualizer"><a href="PointVisualizer.html">PointVisualizer</a></li><li data-name="PolygonGeometry"><a href="PolygonGeometry.html">PolygonGeometry</a></li><li data-name="PolygonGeometryUpdater"><a href="PolygonGeometryUpdater.html">PolygonGeometryUpdater</a></li><li data-name="PolygonGraphics"><a href="PolygonGraphics.html">PolygonGraphics</a></li><li data-name="PolygonHierarchy"><a href="PolygonHierarchy.html">PolygonHierarchy</a></li><li data-name="PolygonOutlineGeometry"><a href="PolygonOutlineGeometry.html">PolygonOutlineGeometry</a></li><li data-name="Polyline"><a href="Polyline.html">Polyline</a></li><li data-name="PolylineArrowMaterialProperty"><a href="PolylineArrowMaterialProperty.html">PolylineArrowMaterialProperty</a></li><li data-name="PolylineCollection"><a href="PolylineCollection.html">PolylineCollection</a></li><li data-name="PolylineColorAppearance"><a href="PolylineColorAppearance.html">PolylineColorAppearance</a></li><li data-name="PolylineGeometry"><a href="PolylineGeometry.html">PolylineGeometry</a></li><li data-name="PolylineGeometryUpdater"><a href="PolylineGeometryUpdater.html">PolylineGeometryUpdater</a></li><li data-name="PolylineGlowMaterialProperty"><a href="PolylineGlowMaterialProperty.html">PolylineGlowMaterialProperty</a></li><li data-name="PolylineGraphics"><a href="PolylineGraphics.html">PolylineGraphics</a></li><li data-name="PolylineMaterialAppearance"><a href="PolylineMaterialAppearance.html">PolylineMaterialAppearance</a></li><li data-name="PolylineOutlineMaterialProperty"><a href="PolylineOutlineMaterialProperty.html">PolylineOutlineMaterialProperty</a></li><li data-name="PolylineVolumeGeometry"><a href="PolylineVolumeGeometry.html">PolylineVolumeGeometry</a></li><li data-name="PolylineVolumeGeometryUpdater"><a href="PolylineVolumeGeometryUpdater.html">PolylineVolumeGeometryUpdater</a></li><li data-name="PolylineVolumeGraphics"><a href="PolylineVolumeGraphics.html">PolylineVolumeGraphics</a></li><li data-name="PolylineVolumeOutlineGeometry"><a href="PolylineVolumeOutlineGeometry.html">PolylineVolumeOutlineGeometry</a></li><li data-name="PositionProperty"><a href="PositionProperty.html">PositionProperty</a></li><li data-name="PositionPropertyArray"><a href="PositionPropertyArray.html">PositionPropertyArray</a></li><li data-name="Primitive"><a href="Primitive.html">Primitive</a></li><li data-name="PrimitiveCollection"><a href="PrimitiveCollection.html">PrimitiveCollection</a></li><li data-name="PrimitiveType"><a href="PrimitiveType.html">PrimitiveType</a></li><li data-name="Property"><a href="Property.html">Property</a></li><li data-name="PropertyArray"><a href="PropertyArray.html">PropertyArray</a></li><li data-name="PropertyBag"><a href="PropertyBag.html">PropertyBag</a></li><li data-name="ProviderViewModel"><a href="ProviderViewModel.html">ProviderViewModel</a></li><li data-name="QuadraticRealPolynomial"><a href="QuadraticRealPolynomial.html">QuadraticRealPolynomial</a></li><li data-name="QuantizedMeshTerrainData"><a href="QuantizedMeshTerrainData.html">QuantizedMeshTerrainData</a></li><li data-name="QuarticRealPolynomial"><a href="QuarticRealPolynomial.html">QuarticRealPolynomial</a></li><li data-name="Quaternion"><a href="Quaternion.html">Quaternion</a></li><li data-name="QuaternionSpline"><a href="QuaternionSpline.html">QuaternionSpline</a></li><li data-name="queryToObject"><a href="queryToObject.html">queryToObject</a></li><li data-name="Queue"><a href="Queue.html">Queue</a></li><li data-name="Ray"><a href="Ray.html">Ray</a></li><li data-name="Rectangle"><a href="Rectangle.html">Rectangle</a></li><li data-name="RectangleGeometry"><a href="RectangleGeometry.html">RectangleGeometry</a></li><li data-name="RectangleGeometryUpdater"><a href="RectangleGeometryUpdater.html">RectangleGeometryUpdater</a></li><li data-name="RectangleGraphics"><a href="RectangleGraphics.html">RectangleGraphics</a></li><li data-name="RectangleOutlineGeometry"><a href="RectangleOutlineGeometry.html">RectangleOutlineGeometry</a></li><li data-name="ReferenceFrame"><a href="ReferenceFrame.html">ReferenceFrame</a></li><li data-name="ReferenceProperty"><a href="ReferenceProperty.html">ReferenceProperty</a></li><li data-name="requestAnimationFrame"><a href="requestAnimationFrame.html">requestAnimationFrame</a></li><li data-name="RequestErrorEvent"><a href="RequestErrorEvent.html">RequestErrorEvent</a></li><li data-name="Rotation"><a href="Rotation.html">Rotation</a></li><li data-name="RuntimeError"><a href="RuntimeError.html">RuntimeError</a></li><li data-name="SampledPositionProperty"><a href="SampledPositionProperty.html">SampledPositionProperty</a></li><li data-name="SampledProperty"><a href="SampledProperty.html">SampledProperty</a></li><li data-name="sampleTerrain"><a href="sampleTerrain.html">sampleTerrain</a></li><li data-name="Scene"><a href="Scene.html">Scene</a></li><li data-name="SceneMode"><a href="SceneMode.html">SceneMode</a></li><li data-name="SceneModePicker"><a href="SceneModePicker.html">SceneModePicker</a></li><li data-name="SceneModePickerViewModel"><a href="SceneModePickerViewModel.html">SceneModePickerViewModel</a></li><li data-name="SceneTransforms"><a href="SceneTransforms.html">SceneTransforms</a></li><li data-name="ScreenSpaceCameraController"><a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></li><li data-name="ScreenSpaceEventHandler"><a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></li><li data-name="ScreenSpaceEventType"><a href="ScreenSpaceEventType.html">ScreenSpaceEventType</a></li><li data-name="SelectionIndicator"><a href="SelectionIndicator.html">SelectionIndicator</a></li><li data-name="SelectionIndicatorViewModel"><a href="SelectionIndicatorViewModel.html">SelectionIndicatorViewModel</a></li><li data-name="ShadowMap"><a href="ShadowMap.html">ShadowMap</a></li><li data-name="ShadowMode"><a href="ShadowMode.html">ShadowMode</a></li><li data-name="ShowGeometryInstanceAttribute"><a href="ShowGeometryInstanceAttribute.html">ShowGeometryInstanceAttribute</a></li><li data-name="Simon1994PlanetaryPositions"><a href="Simon1994PlanetaryPositions.html">Simon1994PlanetaryPositions</a></li><li data-name="SimplePolylineGeometry"><a href="SimplePolylineGeometry.html">SimplePolylineGeometry</a></li><li data-name="SingleTileImageryProvider"><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li><li data-name="SkyAtmosphere"><a href="SkyAtmosphere.html">SkyAtmosphere</a></li><li data-name="SkyBox"><a href="SkyBox.html">SkyBox</a></li><li data-name="SphereGeometry"><a href="SphereGeometry.html">SphereGeometry</a></li><li data-name="SphereOutlineGeometry"><a href="SphereOutlineGeometry.html">SphereOutlineGeometry</a></li><li data-name="Spherical"><a href="Spherical.html">Spherical</a></li><li data-name="Spline"><a href="Spline.html">Spline</a></li><li data-name="StencilFunction"><a href="StencilFunction.html">StencilFunction</a></li><li data-name="StencilOperation"><a href="StencilOperation.html">StencilOperation</a></li><li data-name="StripeMaterialProperty"><a href="StripeMaterialProperty.html">StripeMaterialProperty</a></li><li data-name="StripeOrientation"><a href="StripeOrientation.html">StripeOrientation</a></li><li data-name="subdivideArray"><a href="subdivideArray.html">subdivideArray</a></li><li data-name="Sun"><a href="Sun.html">Sun</a></li><li data-name="SvgPathBindingHandler"><a href="SvgPathBindingHandler.html">SvgPathBindingHandler</a></li><li data-name="TaskProcessor"><a href="TaskProcessor.html">TaskProcessor</a></li><li data-name="TerrainData"><a href="TerrainData.html">TerrainData</a></li><li data-name="TerrainProvider"><a href="TerrainProvider.html">TerrainProvider</a></li><li data-name="throttleRequestByServer"><a href="throttleRequestByServer.html">throttleRequestByServer</a></li><li data-name="TileCoordinatesImageryProvider"><a href="TileCoordinatesImageryProvider.html">TileCoordinatesImageryProvider</a></li><li data-name="TileDiscardPolicy"><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></li><li data-name="TileProviderError"><a href="TileProviderError.html">TileProviderError</a></li><li data-name="TilingScheme"><a href="TilingScheme.html">TilingScheme</a></li><li data-name="TimeInterval"><a href="TimeInterval.html">TimeInterval</a></li><li data-name="TimeIntervalCollection"><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></li><li data-name="TimeIntervalCollectionPositionProperty"><a href="TimeIntervalCollectionPositionProperty.html">TimeIntervalCollectionPositionProperty</a></li><li data-name="TimeIntervalCollectionProperty"><a href="TimeIntervalCollectionProperty.html">TimeIntervalCollectionProperty</a></li><li data-name="Timeline"><a href="Timeline.html">Timeline</a></li><li data-name="TimeStandard"><a href="TimeStandard.html">TimeStandard</a></li><li data-name="ToggleButtonViewModel"><a href="ToggleButtonViewModel.html">ToggleButtonViewModel</a></li><li data-name="Transforms"><a href="Transforms.html">Transforms</a></li><li data-name="TranslationRotationScale"><a href="TranslationRotationScale.html">TranslationRotationScale</a></li><li data-name="TridiagonalSystemSolver"><a href="TridiagonalSystemSolver.html">TridiagonalSystemSolver</a></li><li data-name="TrustedServers"><a href="TrustedServers.html">TrustedServers</a></li><li data-name="UrlTemplateImageryProvider"><a href="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li><li data-name="VelocityOrientationProperty"><a href="VelocityOrientationProperty.html">VelocityOrientationProperty</a></li><li data-name="VelocityVectorProperty"><a href="VelocityVectorProperty.html">VelocityVectorProperty</a></li><li data-name="VertexFormat"><a href="VertexFormat.html">VertexFormat</a></li><li data-name="VerticalOrigin"><a href="VerticalOrigin.html">VerticalOrigin</a></li><li data-name="VideoSynchronizer"><a href="VideoSynchronizer.html">VideoSynchronizer</a></li><li data-name="Viewer"><a href="Viewer.html">Viewer</a></li><li data-name="viewerCesiumInspectorMixin"><a href="viewerCesiumInspectorMixin.html">viewerCesiumInspectorMixin</a></li><li data-name="viewerDragDropMixin"><a href="viewerDragDropMixin.html">viewerDragDropMixin</a></li><li data-name="viewerPerformanceWatchdogMixin"><a href="viewerPerformanceWatchdogMixin.html">viewerPerformanceWatchdogMixin</a></li><li data-name="ViewportQuad"><a href="ViewportQuad.html">ViewportQuad</a></li><li data-name="Visibility"><a href="Visibility.html">Visibility</a></li><li data-name="Visualizer"><a href="Visualizer.html">Visualizer</a></li><li data-name="VRButton"><a href="VRButton.html">VRButton</a></li><li data-name="VRButtonViewModel"><a href="VRButtonViewModel.html">VRButtonViewModel</a></li><li data-name="VRTheWorldTerrainProvider"><a href="VRTheWorldTerrainProvider.html">VRTheWorldTerrainProvider</a></li><li data-name="WallGeometry"><a href="WallGeometry.html">WallGeometry</a></li><li data-name="WallGeometryUpdater"><a href="WallGeometryUpdater.html">WallGeometryUpdater</a></li><li data-name="WallGraphics"><a href="WallGraphics.html">WallGraphics</a></li><li data-name="WallOutlineGeometry"><a href="WallOutlineGeometry.html">WallOutlineGeometry</a></li><li data-name="WebGLConstants"><a href="WebGLConstants.html">WebGLConstants</a></li><li data-name="WebMapServiceImageryProvider"><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li data-name="WebMapTileServiceImageryProvider"><a href="WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li><li data-name="WebMercatorProjection"><a href="WebMercatorProjection.html">WebMercatorProjection</a></li><li data-name="WebMercatorTilingScheme"><a href="WebMercatorTilingScheme.html">WebMercatorTilingScheme</a></li><li data-name="WindingOrder"><a href="WindingOrder.html">WindingOrder</a></li></ul>
  682. </div>
  683. </div>
  684. <script>
  685. if (window.frameElement) {
  686. document.body.className = 'embedded';
  687. var ele = document.createElement('a');
  688. ele.className = 'popout';
  689. ele.target = '_blank';
  690. ele.href = window.location.href;
  691. ele.title = 'Pop out';
  692. document.getElementById('main').appendChild(ele);
  693. }
  694. // Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
  695. Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
  696. if (/^https?:/i.test(a.getAttribute('href'))) {
  697. a.target='_blank';
  698. }
  699. });
  700. </script>
  701. <script src="javascript/prism.js"></script>
  702. <script src="javascript/cesiumDoc.js"></script>
  703. </body>
  704. </html>