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

2764 lines
91 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>BillboardGraphics - 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>
BillboardGraphics
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="BillboardGraphics">
<a href="#BillboardGraphics" class="doc-link"></a>
new Cesium.BillboardGraphics<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/BillboardGraphics.js#L50">DataSources/BillboardGraphics.js 50</a>
</div>
</h4>
</div>
<div class="description">
Describes a two dimensional icon located at the position of the containing <a href="Entity.html"><code>Entity</code></a>.
<p>
<div align='center'>
<img src='Images/Billboard.png' width='400' height='300' /><br />
Example billboards
</div>
</p>
</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="BillboardGraphics.html#.ConstructorOptions">BillboardGraphics.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>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Billboards.html">Cesium Sandcastle Billboard Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="alignedAxis">
<a href="#alignedAxis" class="doc-link"></a>
alignedAxis<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/BillboardGraphics.js#L245">DataSources/BillboardGraphics.js 245</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian3.html"><code>Cartesian3</code></a> Property specifying the unit vector axis of rotation
in the fixed frame. When set to Cartesian3.ZERO the rotation is from the top of the screen.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cartesian3.ZERO</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="color">
<a href="#color" class="doc-link"></a>
color<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/BillboardGraphics.js#L227">DataSources/BillboardGraphics.js 227</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="Color.html"><code>Color</code></a> that is multiplied with the <code>image</code>.
This has two common use cases. First, the same white texture may be used by many different billboards,
each with a different color, to create colored billboards. Second, the color's alpha component can be
used to make the billboard translucent as shown below. An alpha of <code>0.0</code> makes the billboard
transparent, and <code>1.0</code> makes the billboard opaque.
<p>
<div align='center'>
<table border='0' cellpadding='5'><tr>
<td align='center'><code>default</code><br/><img src='Images/Billboard.setColor.Alpha255.png' width='250' height='188' /></td>
<td align='center'><code>alpha : 0.5</code><br/><img src='Images/Billboard.setColor.Alpha127.png' width='250' height='188' /></td>
</tr></table>
</div>
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Color.WHITE</code>
</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/BillboardGraphics.js#L104">DataSources/BillboardGraphics.js 104</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="disableDepthTestDistance">
<a href="#disableDepthTestDistance" class="doc-link"></a>
disableDepthTestDistance<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/BillboardGraphics.js#L330">DataSources/BillboardGraphics.js 330</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<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/BillboardGraphics.js#L320">DataSources/BillboardGraphics.js 320</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</code></a> Property specifying at what distance from the camera that this billboard will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="eyeOffset">
<a href="#eyeOffset" class="doc-link"></a>
eyeOffset<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/BillboardGraphics.js#L183">DataSources/BillboardGraphics.js 183</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian3.html"><code>Cartesian3</code></a> Property specifying the billboard's offset in eye coordinates.
Eye coordinates is a left-handed coordinate system, where <code>x</code> points towards the viewer's
right, <code>y</code> points up, and <code>z</code> points into the screen.
<p>
An eye offset is commonly used to arrange multiple billboards or objects at the same position, e.g., to
arrange a billboard above its corresponding 3D model.
</p>
Below, the billboard is positioned at the center of the Earth but an eye offset makes it always
appear on top of the Earth regardless of the viewer's or Earth's orientation.
<p>
<div align='center'>
<table border='0' cellpadding='5'><tr>
<td align='center'><img src='Images/Billboard.setEyeOffset.one.png' width='250' height='188' /></td>
<td align='center'><img src='Images/Billboard.setEyeOffset.two.png' width='250' height='188' /></td>
</tr></table>
<code>b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);</code>
</div>
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cartesian3.ZERO</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="height">
<a href="#height" class="doc-link"></a>
height<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/BillboardGraphics.js#L269">DataSources/BillboardGraphics.js 269</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the height of the billboard in pixels.
When undefined, the native height is used.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="heightReference">
<a href="#heightReference" class="doc-link"></a>
heightReference<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/BillboardGraphics.js#L207">DataSources/BillboardGraphics.js 207</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="global.html#HeightReference"><code>HeightReference</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">HeightReference.NONE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="horizontalOrigin">
<a href="#horizontalOrigin" class="doc-link"></a>
horizontalOrigin<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/BillboardGraphics.js#L191">DataSources/BillboardGraphics.js 191</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="global.html#HorizontalOrigin"><code>HorizontalOrigin</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">HorizontalOrigin.CENTER</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="image">
<a href="#image" class="doc-link"></a>
image<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/BillboardGraphics.js#L123">DataSources/BillboardGraphics.js 123</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the Image, URI, or Canvas to use for the billboard.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="imageSubRegion">
<a href="#imageSubRegion" class="doc-link"></a>
imageSubRegion<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/BillboardGraphics.js#L313">DataSources/BillboardGraphics.js 313</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying a <a href="BoundingRectangle.html"><code>BoundingRectangle</code></a> that defines a
sub-region of the <code>image</code> to use for the billboard, rather than the entire image,
measured in pixels from the bottom-left.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pixelOffset">
<a href="#pixelOffset" class="doc-link"></a>
pixelOffset<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/BillboardGraphics.js#L158">DataSources/BillboardGraphics.js 158</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian2.html"><code>Cartesian2</code></a> Property specifying the billboard's pixel offset in screen space
from the origin of this billboard. This is commonly used to align multiple billboards and labels at
the same position, e.g., an image and text. The screen space origin is the top, left corner of the
canvas; <code>x</code> increases from left to right, and <code>y</code> increases from top to bottom.
<p>
<div align='center'>
<table border='0' cellpadding='5'><tr>
<td align='center'><code>default</code><br/><img src='Images/Billboard.setPixelOffset.default.png' width='250' height='188' /></td>
<td align='center'><code>b.pixeloffset = new Cartesian2(50, 25);</code><br/><img src='Images/Billboard.setPixelOffset.x50y-25.png' width='250' height='188' /></td>
</tr></table>
The billboard's origin is indicated by the yellow point.
</div>
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cartesian2.ZERO</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="pixelOffsetScaleByDistance">
<a href="#pixelOffsetScaleByDistance" class="doc-link"></a>
pixelOffsetScaleByDistance<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/BillboardGraphics.js#L302">DataSources/BillboardGraphics.js 302</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property specifying the pixel offset of the billboard based on the distance from the camera.
A billboard's pixel offset will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the billboard's pixel offset remains clamped to the nearest bound.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rotation">
<a href="#rotation" class="doc-link"></a>
rotation<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/BillboardGraphics.js#L236">DataSources/BillboardGraphics.js 236</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the rotation of the image
counter clockwise from the <code>alignedAxis</code>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="scale">
<a href="#scale" class="doc-link"></a>
scale<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/BillboardGraphics.js#L138">DataSources/BillboardGraphics.js 138</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the uniform scale to apply to the image.
A scale greater than <code>1.0</code> enlarges the billboard while a scale less than <code>1.0</code> shrinks it.
<p>
<div align='center'>
<img src='Images/Billboard.setScale.png' width='400' height='300' /><br/>
From left to right in the above image, the scales are <code>0.5</code>, <code>1.0</code>, and <code>2.0</code>.
</div>
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="scaleByDistance">
<a href="#scaleByDistance" class="doc-link"></a>
scaleByDistance<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/BillboardGraphics.js#L280">DataSources/BillboardGraphics.js 280</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property specifying the scale of the billboard based on the distance from the camera.
A billboard's scale will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the billboard's scale remains clamped to the nearest bound.
</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"> : <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/BillboardGraphics.js#L116">DataSources/BillboardGraphics.js 116</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the billboard.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="sizeInMeters">
<a href="#sizeInMeters" class="doc-link"></a>
sizeInMeters<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/BillboardGraphics.js#L253">DataSources/BillboardGraphics.js 253</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying if this billboard's size will be measured in meters.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="translucencyByDistance">
<a href="#translucencyByDistance" class="doc-link"></a>
translucencyByDistance<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/BillboardGraphics.js#L291">DataSources/BillboardGraphics.js 291</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property specifying the translucency of the billboard based on the distance from the camera.
A billboard's translucency will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the billboard's translucency remains clamped to the nearest bound.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="verticalOrigin">
<a href="#verticalOrigin" class="doc-link"></a>
verticalOrigin<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/BillboardGraphics.js#L199">DataSources/BillboardGraphics.js 199</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="global.html#VerticalOrigin"><code>VerticalOrigin</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">VerticalOrigin.CENTER</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="width">
<a href="#width" class="doc-link"></a>
width<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/BillboardGraphics.js#L261">DataSources/BillboardGraphics.js 261</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the width of the billboard in pixels.
When undefined, the native width is used.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="BillboardGraphics.html">BillboardGraphics</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/BillboardGraphics.js#L341">DataSources/BillboardGraphics.js 341</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this instance.
</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>result</code></td>
<td class="type">
<span class="param-type"><a href="BillboardGraphics.html">BillboardGraphics</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 instance if one was not provided.
</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/BillboardGraphics.js#L374">DataSources/BillboardGraphics.js 374</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="BillboardGraphics.html">BillboardGraphics</a></span>
</td>
<td class="description last">
The object to be merged into this object.</td>
</tr>
</tbody>
</table>
<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.BillboardGraphics.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/BillboardGraphics.js#L7">DataSources/BillboardGraphics.js 7</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the BillboardGraphics 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>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying the visibility of the billboard.</td>
</tr>
<tr>
<td class="name"><code>image</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">string</span>
|
<span class="param-type">HTMLCanvasElement</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying the Image, URI, or Canvas to use for the billboard.</td>
</tr>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1.0
</td>
<td class="description last">A numeric Property specifying the scale to apply to the image size.</td>
</tr>
<tr>
<td class="name"><code>pixelOffset</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Cartesian2.ZERO
</td>
<td class="description last">A <a href="Cartesian2.html"><code>Cartesian2</code></a> Property specifying the pixel offset.</td>
</tr>
<tr>
<td class="name"><code>eyeOffset</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Cartesian3.ZERO
</td>
<td class="description last">A <a href="Cartesian3.html"><code>Cartesian3</code></a> Property specifying the eye offset.</td>
</tr>
<tr>
<td class="name"><code>horizontalOrigin</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#HorizontalOrigin">HorizontalOrigin</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
HorizontalOrigin.CENTER
</td>
<td class="description last">A Property specifying the <a href="global.html#HorizontalOrigin"><code>HorizontalOrigin</code></a>.</td>
</tr>
<tr>
<td class="name"><code>verticalOrigin</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#VerticalOrigin">VerticalOrigin</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
VerticalOrigin.CENTER
</td>
<td class="description last">A Property specifying the <a href="global.html#VerticalOrigin"><code>VerticalOrigin</code></a>.</td>
</tr>
<tr>
<td class="name"><code>heightReference</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#HeightReference">HeightReference</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
HeightReference.NONE
</td>
<td class="description last">A Property specifying what the height is relative to.</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Color.WHITE
</td>
<td class="description last">A Property specifying the tint <a href="Color.html"><code>Color</code></a> of the image.</td>
</tr>
<tr>
<td class="name"><code>rotation</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last">A numeric Property specifying the rotation about the alignedAxis.</td>
</tr>
<tr>
<td class="name"><code>alignedAxis</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Cartesian3.ZERO
</td>
<td class="description last">A <a href="Cartesian3.html"><code>Cartesian3</code></a> Property specifying the unit vector axis of rotation.</td>
</tr>
<tr>
<td class="name"><code>sizeInMeters</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A boolean Property specifying whether this billboard's size should be measured in meters.</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A numeric Property specifying the width of the billboard in pixels, overriding the native size.</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A numeric Property specifying the height of the billboard in pixels, overriding the native size.</td>
</tr>
<tr>
<td class="name"><code>scaleByDistance</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="NearFarScalar.html">NearFarScalar</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property used to scale the point based on distance from the camera.</td>
</tr>
<tr>
<td class="name"><code>translucencyByDistance</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="NearFarScalar.html">NearFarScalar</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property used to set translucency based on distance from the camera.</td>
</tr>
<tr>
<td class="name"><code>pixelOffsetScaleByDistance</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="NearFarScalar.html">NearFarScalar</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property used to set pixelOffset based on distance from the camera.</td>
</tr>
<tr>
<td class="name"><code>imageSubRegion</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="BoundingRectangle.html">BoundingRectangle</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying a <a href="BoundingRectangle.html"><code>BoundingRectangle</code></a> that defines a sub-region of the image to use for the billboard, rather than the entire image, measured in pixels from the bottom-left.</td>
</tr>
<tr>
<td class="name"><code>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying at what distance from the camera that this billboard will be displayed.</td>
</tr>
<tr>
<td class="name"><code>disableDepthTestDistance</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying the distance from the camera at which to disable the depth test to.</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>