wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/Entity.html

4123 lines
100 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Entity - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
Entity
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Entity">
<a href="#Entity" class="doc-link"></a>
new Cesium.Entity<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L108">DataSources/Entity.js 108</a>
</div>
</h4>
</div>
<div class="description">
Entity instances aggregate multiple forms of visualization into a single high-level object.
They can be created manually and added to <a href="Viewer.html#entities"><code>Viewer#entities</code></a> or be produced by
data sources, such as <a href="CzmlDataSource.html"><code>CzmlDataSource</code></a> and <a href="GeoJsonDataSource.html"><code>GeoJsonDataSource</code></a>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html#.ConstructorOptions">Entity.ConstructorOptions</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object describing initialization options</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://cesium.com/learn/cesiumjs-learn/cesiumjs-creating-entities/">Creating Entities</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="availability">
<a href="#availability" class="doc-link"></a>
availability<span class="type-signature"> : <a href="TimeIntervalCollection.html">TimeIntervalCollection</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L232">DataSources/Entity.js 232</a>
</div>
</h4>
</div>
<div class="description">
The availability, if any, associated with this object.
If availability is undefined, it is assumed that this object's
other properties will return valid data for any provided time.
If availability exists, the objects other properties will only
provide valid data if queried within the given interval.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="billboard">
<a href="#billboard" class="doc-link"></a>
billboard<span class="type-signature"> : <a href="BillboardGraphics.html">BillboardGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L360">DataSources/Entity.js 360</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the billboard.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="box">
<a href="#box" class="doc-link"></a>
box<span class="type-signature"> : <a href="BoxGraphics.html">BoxGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L366">DataSources/Entity.js 366</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the box.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="corridor">
<a href="#corridor" class="doc-link"></a>
corridor<span class="type-signature"> : <a href="CorridorGraphics.html">CorridorGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L372">DataSources/Entity.js 372</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the corridor.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cylinder">
<a href="#cylinder" class="doc-link"></a>
cylinder<span class="type-signature"> : <a href="CylinderGraphics.html">CylinderGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L378">DataSources/Entity.js 378</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the cylinder.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="definitionChanged">
<a href="#definitionChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> definitionChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L250">DataSources/Entity.js 250</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised whenever a property or sub-property is changed or modified.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="description">
<a href="#description" class="doc-link"></a>
description<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L384">DataSources/Entity.js 384</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the description.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ellipse">
<a href="#ellipse" class="doc-link"></a>
ellipse<span class="type-signature"> : <a href="EllipseGraphics.html">EllipseGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L390">DataSources/Entity.js 390</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the ellipse.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ellipsoid">
<a href="#ellipsoid" class="doc-link"></a>
ellipsoid<span class="type-signature"> : <a href="EllipsoidGraphics.html">EllipsoidGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L396">DataSources/Entity.js 396</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the ellipsoid.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entityCollection">
<a href="#entityCollection" class="doc-link"></a>
entityCollection<span class="type-signature"> : <a href="EntityCollection.html">EntityCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L197">DataSources/Entity.js 197</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the entity collection that this entity belongs to.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="id">
<a href="#id" class="doc-link"></a>
id<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L238">DataSources/Entity.js 238</a>
</div>
</h4>
</div>
<div class="description">
Gets the unique ID associated with this object.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isShowing">
<a href="#isShowing" class="doc-link"></a>
isShowing<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L300">DataSources/Entity.js 300</a>
</div>
</h4>
</div>
<div class="description">
Gets whether this entity is being displayed, taking into account
the visibility of any ancestor entities.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="label">
<a href="#label" class="doc-link"></a>
label<span class="type-signature"> : <a href="LabelGraphics.html">LabelGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L402">DataSources/Entity.js 402</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the label.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="model">
<a href="#model" class="doc-link"></a>
model<span class="type-signature"> : <a href="ModelGraphics.html">ModelGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L408">DataSources/Entity.js 408</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the model.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="name">
<a href="#name" class="doc-link"></a>
name<span class="type-signature"> : String|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L261">DataSources/Entity.js 261</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the name of the object. The name is intended for end-user
consumption and does not need to be unique.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="orientation">
<a href="#orientation" class="doc-link"></a>
orientation<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L420">DataSources/Entity.js 420</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the orientation.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="parent">
<a href="#parent" class="doc-link"></a>
parent<span class="type-signature"> : <a href="Entity.html">Entity</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L314">DataSources/Entity.js 314</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the parent object.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="path">
<a href="#path" class="doc-link"></a>
path<span class="type-signature"> : <a href="PathGraphics.html">PathGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L426">DataSources/Entity.js 426</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the path.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="plane">
<a href="#plane" class="doc-link"></a>
plane<span class="type-signature"> : <a href="PlaneGraphics.html">PlaneGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L432">DataSources/Entity.js 432</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the plane.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="point">
<a href="#point" class="doc-link"></a>
point<span class="type-signature"> : <a href="PointGraphics.html">PointGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L438">DataSources/Entity.js 438</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the point graphic.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="polygon">
<a href="#polygon" class="doc-link"></a>
polygon<span class="type-signature"> : <a href="PolygonGraphics.html">PolygonGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L444">DataSources/Entity.js 444</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the polygon.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="polyline">
<a href="#polyline" class="doc-link"></a>
polyline<span class="type-signature"> : <a href="PolylineGraphics.html">PolylineGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L450">DataSources/Entity.js 450</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the polyline.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="polylineVolume">
<a href="#polylineVolume" class="doc-link"></a>
polylineVolume<span class="type-signature"> : <a href="PolylineVolumeGraphics.html">PolylineVolumeGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L456">DataSources/Entity.js 456</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the polyline volume.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="position">
<a href="#position" class="doc-link"></a>
position<span class="type-signature"> : <a href="PositionProperty.html">PositionProperty</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L471">DataSources/Entity.js 471</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the position.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="properties">
<a href="#properties" class="doc-link"></a>
properties<span class="type-signature"> : <a href="PropertyBag.html">PropertyBag</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L465">DataSources/Entity.js 465</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the bag of arbitrary properties associated with this entity.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="propertyNames">
<a href="#propertyNames" class="doc-link"></a>
propertyNames<span class="type-signature"> : Array.&lt;string></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L350">DataSources/Entity.js 350</a>
</div>
</h4>
</div>
<div class="description">
Gets the names of all properties registered on this instance.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangle">
<a href="#rectangle" class="doc-link"></a>
rectangle<span class="type-signature"> : <a href="RectangleGraphics.html">RectangleGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L477">DataSources/Entity.js 477</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the rectangle.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L268">DataSources/Entity.js 268</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether this entity should be displayed. When set to true,
the entity is only displayed if the parent entity's show property is also true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileset">
<a href="#tileset" class="doc-link"></a>
tileset<span class="type-signature"> : <a href="Cesium3DTilesetGraphics.html">Cesium3DTilesetGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L414">DataSources/Entity.js 414</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the tileset.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="viewFrom">
<a href="#viewFrom" class="doc-link"></a>
viewFrom<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L485">DataSources/Entity.js 485</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the suggested initial offset when tracking this object.
The offset is typically defined in the east-north-up reference frame,
but may be another frame depending on the object's velocity.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="wall">
<a href="#wall" class="doc-link"></a>
wall<span class="type-signature"> : <a href="WallGraphics.html">WallGraphics</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L491">DataSources/Entity.js 491</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the wall.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".supportsMaterialsforEntitiesOnTerrain">
<a href="#.supportsMaterialsforEntitiesOnTerrain" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Entity.supportsMaterialsforEntitiesOnTerrain<span class="signature">(scene)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L737">DataSources/Entity.js 737</a>
</div>
</h4>
</div>
<div class="description">
Checks if the given Scene supports materials besides Color on Entities draped on terrain or 3D Tiles.
If this feature is not supported, Entities with non-color materials but no `height` will
instead be rendered as if height is 0.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The current scene.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Whether or not the current scene supports materials for entities on terrain.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".supportsPolylinesOnTerrain">
<a href="#.supportsPolylinesOnTerrain" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Entity.supportsPolylinesOnTerrain<span class="signature">(scene)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L749">DataSources/Entity.js 749</a>
</div>
</h4>
</div>
<div class="description">
Checks if the given Scene supports polylines clamped to terrain or 3D Tiles.
If this feature is not supported, Entities with PolylineGraphics will be rendered with vertices at
the provided heights and using the `arcType` parameter instead of clamped to the ground.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The current scene.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Whether or not the current scene supports polylines on terrain or 3D TIles.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="addProperty">
<a href="#addProperty" class="doc-link"></a>
addProperty<span class="signature">(propertyName)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L521">DataSources/Entity.js 521</a>
</div>
</h4>
</div>
<div class="description">
Adds a property to this object. Once a property is added, it can be
observed with <a href="Entity.html#definitionChanged"><code>Entity#definitionChanged</code></a> and composited
with <a href="CompositeEntityCollection.html"><code>CompositeEntityCollection</code></a>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The name of the property to add.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: "propertyName" is a reserved property name.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: "propertyName" is already a registered property.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="computeModelMatrix">
<a href="#computeModelMatrix" class="doc-link"></a>
computeModelMatrix<span class="signature">(time, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L643">DataSources/Entity.js 643</a>
</div>
</h4>
</div>
<div class="description">
Computes the model matrix for the entity's transform at specified time. Returns undefined if orientation or position
are undefined.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time to retrieve model matrix for.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position or orientation are undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isAvailable">
<a href="#isAvailable" class="doc-link"></a>
isAvailable<span class="signature">(time)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L500">DataSources/Entity.js 500</a>
</div>
</h4>
</div>
<div class="description">
Given a time, returns true if this object should have data during that time.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time to check availability for.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if the object should have data during the provided time, false otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="merge">
<a href="#merge" class="doc-link"></a>
merge<span class="signature">(source)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L577">DataSources/Entity.js 577</a>
</div>
</h4>
</div>
<div class="description">
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</a></span>
</td>
<td class="description last">
The object to be merged into this object.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="removeProperty">
<a href="#removeProperty" class="doc-link"></a>
removeProperty<span class="signature">(propertyName)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L554">DataSources/Entity.js 554</a>
</div>
</h4>
</div>
<div class="description">
Removed a property previously added with addProperty.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The name of the property to remove.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: "propertyName" is a reserved property name.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: "propertyName" is not a registered property.
</div>
</li>
</ul>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.Entity.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/Entity.js#L63">DataSources/Entity.js 63</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the Entity constructor
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A unique identifier for this object. If none is provided, a GUID is generated.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A human readable name to display to users. It does not have to be unique.</td>
</tr>
<tr>
<td class="name"><code>availability</code></td>
<td class="type">
<span class="param-type"><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The availability, if any, associated with this object.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A boolean value indicating if the entity and its children are displayed.</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A string Property specifying an HTML description for this entity.</td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="PositionProperty.html">PositionProperty</a></span>
|
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A Property specifying the entity position.</td>
</tr>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A Property specifying the entity orientation.</td>
</tr>
<tr>
<td class="name"><code>viewFrom</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A suggested initial offset for viewing this object.</td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A parent entity to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>billboard</code></td>
<td class="type">
<span class="param-type"><a href="BillboardGraphics.html">BillboardGraphics</a></span>
|
<span class="param-type"><a href="BillboardGraphics.html#.ConstructorOptions">BillboardGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A billboard to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>box</code></td>
<td class="type">
<span class="param-type"><a href="BoxGraphics.html">BoxGraphics</a></span>
|
<span class="param-type"><a href="BoxGraphics.html#.ConstructorOptions">BoxGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A box to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>corridor</code></td>
<td class="type">
<span class="param-type"><a href="CorridorGraphics.html">CorridorGraphics</a></span>
|
<span class="param-type"><a href="CorridorGraphics.html#.ConstructorOptions">CorridorGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A corridor to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>cylinder</code></td>
<td class="type">
<span class="param-type"><a href="CylinderGraphics.html">CylinderGraphics</a></span>
|
<span class="param-type"><a href="CylinderGraphics.html#.ConstructorOptions">CylinderGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A cylinder to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>ellipse</code></td>
<td class="type">
<span class="param-type"><a href="EllipseGraphics.html">EllipseGraphics</a></span>
|
<span class="param-type"><a href="EllipseGraphics.html#.ConstructorOptions">EllipseGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A ellipse to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="EllipsoidGraphics.html">EllipsoidGraphics</a></span>
|
<span class="param-type"><a href="EllipsoidGraphics.html#.ConstructorOptions">EllipsoidGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A ellipsoid to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>label</code></td>
<td class="type">
<span class="param-type"><a href="LabelGraphics.html">LabelGraphics</a></span>
|
<span class="param-type"><a href="LabelGraphics.html#.ConstructorOptions">LabelGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A options.label to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>model</code></td>
<td class="type">
<span class="param-type"><a href="ModelGraphics.html">ModelGraphics</a></span>
|
<span class="param-type"><a href="ModelGraphics.html#.ConstructorOptions">ModelGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A model to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>tileset</code></td>
<td class="type">
<span class="param-type"><a href="Cesium3DTilesetGraphics.html">Cesium3DTilesetGraphics</a></span>
|
<span class="param-type"><a href="Cesium3DTilesetGraphics.html#.ConstructorOptions">Cesium3DTilesetGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A 3D Tiles tileset to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type"><a href="PathGraphics.html">PathGraphics</a></span>
|
<span class="param-type"><a href="PathGraphics.html#.ConstructorOptions">PathGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A path to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>plane</code></td>
<td class="type">
<span class="param-type"><a href="PlaneGraphics.html">PlaneGraphics</a></span>
|
<span class="param-type"><a href="PlaneGraphics.html#.ConstructorOptions">PlaneGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A plane to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>point</code></td>
<td class="type">
<span class="param-type"><a href="PointGraphics.html">PointGraphics</a></span>
|
<span class="param-type"><a href="PointGraphics.html#.ConstructorOptions">PointGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A point to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>polygon</code></td>
<td class="type">
<span class="param-type"><a href="PolygonGraphics.html">PolygonGraphics</a></span>
|
<span class="param-type"><a href="PolygonGraphics.html#.ConstructorOptions">PolygonGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A polygon to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>polyline</code></td>
<td class="type">
<span class="param-type"><a href="PolylineGraphics.html">PolylineGraphics</a></span>
|
<span class="param-type"><a href="PolylineGraphics.html#.ConstructorOptions">PolylineGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A polyline to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type"><a href="PropertyBag.html">PropertyBag</a></span>
|
<span class="param-type">Object.&lt;string, *></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">Arbitrary properties to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>polylineVolume</code></td>
<td class="type">
<span class="param-type"><a href="PolylineVolumeGraphics.html">PolylineVolumeGraphics</a></span>
|
<span class="param-type"><a href="PolylineVolumeGraphics.html#.ConstructorOptions">PolylineVolumeGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A polylineVolume to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="RectangleGraphics.html">RectangleGraphics</a></span>
|
<span class="param-type"><a href="RectangleGraphics.html#.ConstructorOptions">RectangleGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A rectangle to associate with this entity.</td>
</tr>
<tr>
<td class="name"><code>wall</code></td>
<td class="type">
<span class="param-type"><a href="WallGraphics.html">WallGraphics</a></span>
|
<span class="param-type"><a href="WallGraphics.html#.ConstructorOptions">WallGraphics.ConstructorOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A wall to associate with this entity.</td>
</tr>
</tbody>
</table>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<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="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">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="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</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="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</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="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</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="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">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="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>