LabelCollection.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551
  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>LabelCollection - 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. LabelCollection
  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="LabelCollection">
  29. <a href="#LabelCollection" class="doc-link"></a>
  30. new Cesium.LabelCollection<span class="signature">(<span class="optional">options</span>)</span>
  31. <div class="source-link rightLinks">
  32. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L468">Scene/LabelCollection.js 468</a>
  33. </div>
  34. </h4>
  35. </div>
  36. </dt>
  37. <dd>
  38. <div class="description">
  39. A renderable collection of labels. Labels are viewport-aligned text positioned in the 3D scene. Each label can have a different font, color, scale, etc. <br /><br /> <div align='center'> <img src='images/Label.png' width='400' height='300' /><br /> Example labels </div> <br /><br /> Labels are added and removed from the collection using <a href="LabelCollection.html#add"><code>LabelCollection#add</code></a> and <a href="LabelCollection.html#remove"><code>LabelCollection#remove</code></a>.
  40. </div>
  41. <h5>Performance:</h5>
  42. <p class="description">For best performance, prefer a few collections, each with many labels, to many collections with only a few labels each. Avoid having collections where some labels change every frame and others do not; instead, create one or more collections for static labels, and one or more collections for dynamic labels.</p>
  43. <table class="params">
  44. <thead>
  45. <tr>
  46. <th>Name</th>
  47. <th>Type</th>
  48. <th class="last">Description</th>
  49. </tr>
  50. </thead>
  51. <tbody>
  52. <tr>
  53. <td class="name"><code>options</code></td>
  54. <td class="type">
  55. <span class="param-type">Object</span>
  56. </td>
  57. <td class="description last">
  58. <span class="optional">optional</span>
  59. Object with the following properties:
  60. <table class="params">
  61. <thead>
  62. <tr>
  63. <th>Name</th>
  64. <th>Type</th>
  65. <th>Default</th>
  66. <th class="last">Description</th>
  67. </tr>
  68. </thead>
  69. <tbody>
  70. <tr>
  71. <td class="name"><code>modelMatrix</code></td>
  72. <td class="type">
  73. <span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
  74. </td>
  75. <td class="default">
  76. <code class="language-javascript">Matrix4.IDENTITY</code>
  77. </td>
  78. <td class="description last">
  79. <span class="optional">optional</span>
  80. The 4x4 transformation matrix that transforms each label from model to world coordinates.</td>
  81. </tr>
  82. <tr>
  83. <td class="name"><code>debugShowBoundingVolume</code></td>
  84. <td class="type">
  85. <span class="param-type">Boolean</span>
  86. </td>
  87. <td class="default">
  88. <code class="language-javascript">false</code>
  89. </td>
  90. <td class="description last">
  91. <span class="optional">optional</span>
  92. For debugging only. Determines if this primitive's commands' bounding spheres are shown.</td>
  93. </tr>
  94. <tr>
  95. <td class="name"><code>scene</code></td>
  96. <td class="type">
  97. <span class="param-type"><a href="Scene.html">Scene</a></span>
  98. </td>
  99. <td class="default">
  100. </td>
  101. <td class="description last">
  102. <span class="optional">optional</span>
  103. Must be passed in for labels that use the height reference property or will be depth tested against the globe.</td>
  104. </tr>
  105. </tbody>
  106. </table>
  107. </td>
  108. </tr>
  109. </tbody>
  110. </table>
  111. <dl class="details">
  112. <h5>Example:</h5>
  113. <pre><code class="language-javascript">// Create a label collection with two labels var labels = scene.primitives.add(new Cesium.LabelCollection()); labels.add({ position : new Cesium.Cartesian3(1.0, 2.0, 3.0), text : 'A label' }); labels.add({ position : new Cesium.Cartesian3(4.0, 5.0, 6.0), text : 'Another label' });</code></pre>
  114. <h5>Demo:</h5>
  115. <ul class="see-list">
  116. <li><a href="http://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Labels.html">Cesium Sandcastle Labels Demo</a></li>
  117. </ul>
  118. <h5>See:</h5>
  119. <ul class="see-list">
  120. <li><a href="LabelCollection.html#add">LabelCollection#add</a></li>
  121. <li><a href="LabelCollection.html#remove">LabelCollection#remove</a></li>
  122. <li><a href="Label.html">Label</a></li>
  123. <li><a href="BillboardCollection.html">BillboardCollection</a></li>
  124. </ul>
  125. </dl>
  126. </dd>
  127. </div>
  128. <h3 class="subsection-title">Members</h3>
  129. <dl>
  130. <dt>
  131. <div class="nameContainer">
  132. <h4 class="name" id="debugShowBoundingVolume">
  133. <a href="#debugShowBoundingVolume" class="doc-link"></a>
  134. debugShowBoundingVolume<span class="type-signature"> : Boolean</span>
  135. <div class="source-link rightLinks">
  136. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L535">Scene/LabelCollection.js 535</a>
  137. </div>
  138. </h4>
  139. </div>
  140. </dt>
  141. <dd>
  142. <div class="description">
  143. This property is for debugging only; it is not for production use nor is it optimized. <p> Draws the bounding sphere for each draw command in the primitive. </p>
  144. </div>
  145. <dl class="details">
  146. <span class="details-header">Default Value:</span>
  147. <code class="language-javascript">false</code>
  148. </dl>
  149. </dd>
  150. <dt>
  151. <div class="nameContainer">
  152. <h4 class="name" id="length">
  153. <a href="#length" class="doc-link"></a>
  154. length<span class="type-signature"> : Number</span>
  155. <div class="source-link rightLinks">
  156. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L546">Scene/LabelCollection.js 546</a>
  157. </div>
  158. </h4>
  159. </div>
  160. </dt>
  161. <dd>
  162. <div class="description">
  163. Returns the number of labels in this collection. This is commonly used with <a href="LabelCollection.html#get"><code>LabelCollection#get</code></a> to iterate over all the labels in the collection.
  164. </div>
  165. <dl class="details">
  166. </dl>
  167. </dd>
  168. <dt>
  169. <div class="nameContainer">
  170. <h4 class="name" id="modelMatrix">
  171. <a href="#modelMatrix" class="doc-link"></a>
  172. modelMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
  173. <div class="source-link rightLinks">
  174. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L523">Scene/LabelCollection.js 523</a>
  175. </div>
  176. </h4>
  177. </div>
  178. </dt>
  179. <dd>
  180. <div class="description">
  181. The 4x4 transformation matrix that transforms each label in this collection from model to world coordinates. When this is the identity matrix, the labels are drawn in world coordinates, i.e., Earth's WGS84 coordinates. Local reference frames can be used by providing a different transformation matrix, like that returned by <a href="Transforms.html#.eastNorthUpToFixedFrame"><code>Transforms.eastNorthUpToFixedFrame</code></a>.
  182. </div>
  183. <dl class="details">
  184. <span class="details-header">Default Value:</span>
  185. <code class="language-javascript"><a href="Matrix4.html#.IDENTITY"><code>Matrix4.IDENTITY</code></a></code>
  186. <h5>Example:</h5>
  187. <pre><code class="language-javascript">var center = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883); labels.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(center); labels.add({ position : new Cesium.Cartesian3(0.0, 0.0, 0.0), text : 'Center' }); labels.add({ position : new Cesium.Cartesian3(1000000.0, 0.0, 0.0), text : 'East' }); labels.add({ position : new Cesium.Cartesian3(0.0, 1000000.0, 0.0), text : 'North' }); labels.add({ position : new Cesium.Cartesian3(0.0, 0.0, 1000000.0), text : 'Up' });</code></pre>
  188. </dl>
  189. </dd>
  190. </dl>
  191. <h3 class="subsection-title">Methods</h3>
  192. <dl>
  193. <dt>
  194. <div class="nameContainer">
  195. <h4 class="name" id="add">
  196. <a href="#add" class="doc-link"></a>
  197. add<span class="signature">(<span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType"><a href="Label.html">Label</a></span>
  198. <div class="source-link rightLinks">
  199. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L605">Scene/LabelCollection.js 605</a>
  200. </div>
  201. </h4>
  202. </div>
  203. </dt>
  204. <dd>
  205. <div class="description">
  206. Creates and adds a label with the specified initial properties to the collection. The added label is returned so it can be modified or removed from the collection later.
  207. </div>
  208. <h5>Performance:</h5>
  209. <p class="description">Calling <code>add</code> is expected constant time. However, the collection's vertex buffer is rewritten; this operations is <code>O(n)</code> and also incurs CPU to GPU overhead. For best performance, add as many billboards as possible before calling <code>update</code>.</p>
  210. <table class="params">
  211. <thead>
  212. <tr>
  213. <th>Name</th>
  214. <th>Type</th>
  215. <th class="last">Description</th>
  216. </tr>
  217. </thead>
  218. <tbody>
  219. <tr>
  220. <td class="name"><code>options</code></td>
  221. <td class="type">
  222. <span class="param-type">Object</span>
  223. </td>
  224. <td class="description last">
  225. <span class="optional">optional</span>
  226. A template describing the label's properties as shown in Example 1.</td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <h5>Returns:</h5>
  231. <div class="param-desc">
  232. The label that was added to the collection.
  233. </div>
  234. <h5>Throws:</h5>
  235. <ul>
  236. <li>
  237. <div class="param-desc">
  238. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  239. : This object was destroyed, i.e., destroy() was called.
  240. </div>
  241. </li>
  242. </ul>
  243. <dl class="details">
  244. <h5>Examples:</h5>
  245. <pre><code class="language-javascript">// Example 1: Add a label, specifying all the default values. var l = labels.add({ show : true, position : Cesium.Cartesian3.ZERO, text : '', font : '30px sans-serif', fillColor : Cesium.Color.WHITE, outlineColor : Cesium.Color.BLACK, outlineWidth : 1.0, showBackground : false, backgroundColor : new Cesium.Color(0.165, 0.165, 0.165, 0.8), backgroundPadding : new Cesium.Cartesian2(7, 5), style : Cesium.LabelStyle.FILL, pixelOffset : Cesium.Cartesian2.ZERO, eyeOffset : Cesium.Cartesian3.ZERO, horizontalOrigin : Cesium.HorizontalOrigin.LEFT, verticalOrigin : Cesium.VerticalOrigin.BASELINE, scale : 1.0, translucencyByDistance : undefined, pixelOffsetScaleByDistance : undefined, heightReference : HeightReference.NONE, distanceDisplayCondition : undefined });</code></pre>
  246. <pre><code class="language-javascript">// Example 2: Specify only the label's cartographic position, // text, and font. var l = labels.add({ position : Cesium.Cartesian3.fromRadians(longitude, latitude, height), text : 'Hello World', font : '24px Helvetica', });</code></pre>
  247. <h5>See:</h5>
  248. <ul class="see-list">
  249. <li><a href="LabelCollection.html#remove">LabelCollection#remove</a></li>
  250. <li><a href="LabelCollection.html#removeAll">LabelCollection#removeAll</a></li>
  251. </ul>
  252. </dl>
  253. </dd>
  254. <dt>
  255. <div class="nameContainer">
  256. <h4 class="name" id="contains">
  257. <a href="#contains" class="doc-link"></a>
  258. contains<span class="signature">(label)</span> &rarr; <span class="type-signature returnType">Boolean</span>
  259. <div class="source-link rightLinks">
  260. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L684">Scene/LabelCollection.js 684</a>
  261. </div>
  262. </h4>
  263. </div>
  264. </dt>
  265. <dd>
  266. <div class="description">
  267. Check whether this collection contains a given label.
  268. </div>
  269. <table class="params">
  270. <thead>
  271. <tr>
  272. <th>Name</th>
  273. <th>Type</th>
  274. <th class="last">Description</th>
  275. </tr>
  276. </thead>
  277. <tbody>
  278. <tr>
  279. <td class="name"><code>label</code></td>
  280. <td class="type">
  281. <span class="param-type"><a href="Label.html">Label</a></span>
  282. </td>
  283. <td class="description last">
  284. The label to check for.</td>
  285. </tr>
  286. </tbody>
  287. </table>
  288. <h5>Returns:</h5>
  289. <div class="param-desc">
  290. true if this collection contains the label, false otherwise.
  291. </div>
  292. <dl class="details">
  293. <h5>See:</h5>
  294. <ul class="see-list">
  295. <li><a href="LabelCollection.html#get">LabelCollection#get</a></li>
  296. </ul>
  297. </dl>
  298. </dd>
  299. <dt>
  300. <div class="nameContainer">
  301. <h4 class="name" id="destroy">
  302. <a href="#destroy" class="doc-link"></a>
  303. destroy<span class="signature">()</span> &rarr; <span class="type-signature returnType">undefined</span>
  304. <div class="source-link rightLinks">
  305. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L828">Scene/LabelCollection.js 828</a>
  306. </div>
  307. </h4>
  308. </div>
  309. </dt>
  310. <dd>
  311. <div class="description">
  312. Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. <br /><br /> Once an object is destroyed, it should not be used; calling any function other than <code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore, assign the return value (<code>undefined</code>) to the object as done in the example.
  313. </div>
  314. <h5>Returns:</h5>
  315. <h5>Throws:</h5>
  316. <ul>
  317. <li>
  318. <div class="param-desc">
  319. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  320. : This object was destroyed, i.e., destroy() was called.
  321. </div>
  322. </li>
  323. </ul>
  324. <dl class="details">
  325. <h5>Example:</h5>
  326. <pre><code class="language-javascript">labels = labels &amp;&amp; labels.destroy();</code></pre>
  327. <h5>See:</h5>
  328. <ul class="see-list">
  329. <li><a href="LabelCollection.html#isDestroyed">LabelCollection#isDestroyed</a></li>
  330. </ul>
  331. </dl>
  332. </dd>
  333. <dt>
  334. <div class="nameContainer">
  335. <h4 class="name" id="get">
  336. <a href="#get" class="doc-link"></a>
  337. get<span class="signature">(index)</span> &rarr; <span class="type-signature returnType"><a href="Label.html">Label</a></span>
  338. <div class="source-link rightLinks">
  339. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L716">Scene/LabelCollection.js 716</a>
  340. </div>
  341. </h4>
  342. </div>
  343. </dt>
  344. <dd>
  345. <div class="description">
  346. Returns the label in the collection at the specified index. Indices are zero-based and increase as labels are added. Removing a label shifts all labels after it to the left, changing their indices. This function is commonly used with <a href="LabelCollection.html#length"><code>LabelCollection#length</code></a> to iterate over all the labels in the collection.
  347. </div>
  348. <h5>Performance:</h5>
  349. <p class="description">Expected constant time. If labels were removed from the collection and <code>Scene#render</code> was not called, an implicit <code>O(n)</code> operation is performed.</p>
  350. <table class="params">
  351. <thead>
  352. <tr>
  353. <th>Name</th>
  354. <th>Type</th>
  355. <th class="last">Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td class="name"><code>index</code></td>
  361. <td class="type">
  362. <span class="param-type">Number</span>
  363. </td>
  364. <td class="description last">
  365. The zero-based index of the billboard.</td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. <h5>Returns:</h5>
  370. <div class="param-desc">
  371. The label at the specified index.
  372. </div>
  373. <h5>Throws:</h5>
  374. <ul>
  375. <li>
  376. <div class="param-desc">
  377. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  378. : This object was destroyed, i.e., destroy() was called.
  379. </div>
  380. </li>
  381. </ul>
  382. <dl class="details">
  383. <h5>Example:</h5>
  384. <pre><code class="language-javascript">// Toggle the show property of every label in the collection var len = labels.length; for (var i = 0; i &lt; len; ++i) { var l = billboards.get(i); l.show = !l.show; }</code></pre>
  385. <h5>See:</h5>
  386. <ul class="see-list">
  387. <li><a href="LabelCollection.html#length">LabelCollection#length</a></li>
  388. </ul>
  389. </dl>
  390. </dd>
  391. <dt>
  392. <div class="nameContainer">
  393. <h4 class="name" id="isDestroyed">
  394. <a href="#isDestroyed" class="doc-link"></a>
  395. isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
  396. <div class="source-link rightLinks">
  397. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L806">Scene/LabelCollection.js 806</a>
  398. </div>
  399. </h4>
  400. </div>
  401. </dt>
  402. <dd>
  403. <div class="description">
  404. Returns true if this object was destroyed; otherwise, false. <br /><br /> If this object was destroyed, it should not be used; calling any function other than <code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
  405. </div>
  406. <h5>Returns:</h5>
  407. <div class="param-desc">
  408. True if this object was destroyed; otherwise, false.
  409. </div>
  410. <dl class="details">
  411. <h5>See:</h5>
  412. <ul class="see-list">
  413. <li><a href="LabelCollection.html#destroy">LabelCollection#destroy</a></li>
  414. </ul>
  415. </dl>
  416. </dd>
  417. <dt>
  418. <div class="nameContainer">
  419. <h4 class="name" id="remove">
  420. <a href="#remove" class="doc-link"></a>
  421. remove<span class="signature">(label)</span> &rarr; <span class="type-signature returnType">Boolean</span>
  422. <div class="source-link rightLinks">
  423. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L637">Scene/LabelCollection.js 637</a>
  424. </div>
  425. </h4>
  426. </div>
  427. </dt>
  428. <dd>
  429. <div class="description">
  430. Removes a label from the collection. Once removed, a label is no longer usable.
  431. </div>
  432. <h5>Performance:</h5>
  433. <p class="description">Calling <code>remove</code> is expected constant time. However, the collection's vertex buffer is rewritten - an <code>O(n)</code> operation that also incurs CPU to GPU overhead. For best performance, remove as many labels as possible before calling <code>update</code>. If you intend to temporarily hide a label, it is usually more efficient to call <a href="Label.html#show"><code>Label#show</code></a> instead of removing and re-adding the label.</p>
  434. <table class="params">
  435. <thead>
  436. <tr>
  437. <th>Name</th>
  438. <th>Type</th>
  439. <th class="last">Description</th>
  440. </tr>
  441. </thead>
  442. <tbody>
  443. <tr>
  444. <td class="name"><code>label</code></td>
  445. <td class="type">
  446. <span class="param-type"><a href="Label.html">Label</a></span>
  447. </td>
  448. <td class="description last">
  449. The label to remove.</td>
  450. </tr>
  451. </tbody>
  452. </table>
  453. <h5>Returns:</h5>
  454. <div class="param-desc">
  455. <code>true</code> if the label was removed; <code>false</code> if the label was not found in the collection.
  456. </div>
  457. <h5>Throws:</h5>
  458. <ul>
  459. <li>
  460. <div class="param-desc">
  461. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  462. : This object was destroyed, i.e., destroy() was called.
  463. </div>
  464. </li>
  465. </ul>
  466. <dl class="details">
  467. <h5>Example:</h5>
  468. <pre><code class="language-javascript">var l = labels.add(...); labels.remove(l); // Returns true</code></pre>
  469. <h5>See:</h5>
  470. <ul class="see-list">
  471. <li><a href="LabelCollection.html#add">LabelCollection#add</a></li>
  472. <li><a href="LabelCollection.html#removeAll">LabelCollection#removeAll</a></li>
  473. <li><a href="Label.html#show">Label#show</a></li>
  474. </ul>
  475. </dl>
  476. </dd>
  477. <dt>
  478. <div class="nameContainer">
  479. <h4 class="name" id="removeAll">
  480. <a href="#removeAll" class="doc-link"></a>
  481. removeAll<span class="signature">()</span>
  482. <div class="source-link rightLinks">
  483. <a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.29/Source/Scene/LabelCollection.js#L666">Scene/LabelCollection.js 666</a>
  484. </div>
  485. </h4>
  486. </div>
  487. </dt>
  488. <dd>
  489. <div class="description">
  490. Removes all labels from the collection.
  491. </div>
  492. <h5>Performance:</h5>
  493. <p class="description"><code>O(n)</code>. It is more efficient to remove all the labels from a collection and then add new ones than to create a new collection entirely.</p>
  494. <h5>Throws:</h5>
  495. <ul>
  496. <li>
  497. <div class="param-desc">
  498. <span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
  499. : This object was destroyed, i.e., destroy() was called.
  500. </div>
  501. </li>
  502. </ul>
  503. <dl class="details">
  504. <h5>Example:</h5>
  505. <pre><code class="language-javascript">labels.add(...); labels.add(...); labels.removeAll();</code></pre>
  506. <h5>See:</h5>
  507. <ul class="see-list">
  508. <li><a href="LabelCollection.html#add">LabelCollection#add</a></li>
  509. <li><a href="LabelCollection.html#remove">LabelCollection#remove</a></li>
  510. </ul>
  511. </dl>
  512. </dd>
  513. </dl>
  514. </article>
  515. </section>
  516. <footer>
  517. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
  518. </footer>
  519. </div>
  520. <div class="nav">
  521. <div class="menu">
  522. <input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
  523. <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>
  524. </div>
  525. </div>
  526. <script>
  527. if (window.frameElement) {
  528. document.body.className = 'embedded';
  529. var ele = document.createElement('a');
  530. ele.className = 'popout';
  531. ele.target = '_blank';
  532. ele.href = window.location.href;
  533. ele.title = 'Pop out';
  534. document.getElementById('main').appendChild(ele);
  535. }
  536. // Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
  537. Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
  538. if (/^https?:/i.test(a.getAttribute('href'))) {
  539. a.target='_blank';
  540. }
  541. });
  542. </script>
  543. <script src="javascript/prism.js"></script>
  544. <script src="javascript/cesiumDoc.js"></script>
  545. </body>
  546. </html>