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

2848 lines
90 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>LabelGraphics - 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>
LabelGraphics
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="LabelGraphics">
<a href="#LabelGraphics" class="doc-link"></a>
new Cesium.LabelGraphics<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/LabelGraphics.js#L51">DataSources/LabelGraphics.js 51</a>
</div>
</h4>
</div>
<div class="description">
Describes a two dimensional label located at the position of the containing <a href="Entity.html"><code>Entity</code></a>.
<p>
<div align='center'>
<img src='Images/Label.png' width='400' height='300' /><br />
Example labels
</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="LabelGraphics.html#.ConstructorOptions">LabelGraphics.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=Labels.html">Cesium Sandcastle Labels Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="backgroundColor">
<a href="#backgroundColor" class="doc-link"></a>
backgroundColor<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/LabelGraphics.js#L173">DataSources/LabelGraphics.js 173</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the background <a href="Color.html"><code>Color</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Color(0.165, 0.165, 0.165, 0.8)</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="backgroundPadding">
<a href="#backgroundPadding" class="doc-link"></a>
backgroundPadding<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/LabelGraphics.js#L182">DataSources/LabelGraphics.js 182</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian2.html"><code>Cartesian2</code></a> Property specifying the label's horizontal and vertical
background padding in pixels.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Cartesian2(7, 5)</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/LabelGraphics.js#L107">DataSources/LabelGraphics.js 107</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/LabelGraphics.js#L323">DataSources/LabelGraphics.js 323</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/LabelGraphics.js#L313">DataSources/LabelGraphics.js 313</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 label 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/LabelGraphics.js#L227">DataSources/LabelGraphics.js 227</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian3.html"><code>Cartesian3</code></a> Property specifying the label'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 labels or objects at the same position, e.g., to
arrange a label above its corresponding 3D model.
</p>
Below, the label 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>l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);</code><br /><br />
</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="fillColor">
<a href="#fillColor" class="doc-link"></a>
fillColor<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/LabelGraphics.js#L256">DataSources/LabelGraphics.js 256</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the fill <a href="Color.html"><code>Color</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="font">
<a href="#font" class="doc-link"></a>
font<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/LabelGraphics.js#L134">DataSources/LabelGraphics.js 134</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the string Property specifying the font in CSS syntax.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS/font">CSS font on MDN</a></li>
</ul>
</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/LabelGraphics.js#L249">DataSources/LabelGraphics.js 249</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/LabelGraphics.js#L234">DataSources/LabelGraphics.js 234</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">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineColor">
<a href="#outlineColor" class="doc-link"></a>
outlineColor<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/LabelGraphics.js#L263">DataSources/LabelGraphics.js 263</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the outline <a href="Color.html"><code>Color</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineWidth">
<a href="#outlineWidth" class="doc-link"></a>
outlineWidth<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/LabelGraphics.js#L270">DataSources/LabelGraphics.js 270</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the outline width.
</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/LabelGraphics.js#L202">DataSources/LabelGraphics.js 202</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="Cartesian2.html"><code>Cartesian2</code></a> Property specifying the label's pixel offset in screen space
from the origin of this label. This is commonly used to align multiple labels 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/Label.setPixelOffset.default.png' width='250' height='188' /></td>
<td align='center'><code>l.pixeloffset = new Cartesian2(25, 75);</code><br/><img src='Images/Label.setPixelOffset.x50y-25.png' width='250' height='188' /></td>
</tr></table>
The label'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/LabelGraphics.js#L292">DataSources/LabelGraphics.js 292</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 label based on the distance from the camera.
A label'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 label's pixel offset remains clamped to the nearest bound.
</div>
<dl class="details">
</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/LabelGraphics.js#L157">DataSources/LabelGraphics.js 157</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 label while a scale less than <code>1.0</code> shrinks it.
<p>
<div align='center'>
<img src='Images/Label.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/LabelGraphics.js#L306">DataSources/LabelGraphics.js 306</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets near and far scaling properties of a Label based on the label's distance from the camera.
A label'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 label's scale remains clamped to the nearest bound. If undefined,
scaleByDistance will be disabled.
</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/LabelGraphics.js#L118">DataSources/LabelGraphics.js 118</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the label.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="showBackground">
<a href="#showBackground" class="doc-link"></a>
showBackground<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/LabelGraphics.js#L165">DataSources/LabelGraphics.js 165</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the background behind the label.
</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="style">
<a href="#style" class="doc-link"></a>
style<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/LabelGraphics.js#L141">DataSources/LabelGraphics.js 141</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="global.html#LabelStyle"><code>LabelStyle</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="text">
<a href="#text" class="doc-link"></a>
text<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/LabelGraphics.js#L126">DataSources/LabelGraphics.js 126</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the string Property specifying the text of the label.
Explicit newlines '\n' are supported.
</div>
<dl class="details">
</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/LabelGraphics.js#L281">DataSources/LabelGraphics.js 281</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets <a href="NearFarScalar.html"><code>NearFarScalar</code></a> Property specifying the translucency of the label based on the distance from the camera.
A label'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 label'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/LabelGraphics.js#L241">DataSources/LabelGraphics.js 241</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">
</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="LabelGraphics.html">LabelGraphics</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/LabelGraphics.js#L334">DataSources/LabelGraphics.js 334</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="LabelGraphics.html">LabelGraphics</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/LabelGraphics.js#L368">DataSources/LabelGraphics.js 368</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="LabelGraphics.html">LabelGraphics</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.LabelGraphics.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/LabelGraphics.js#L7">DataSources/LabelGraphics.js 7</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the LabelGraphics 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 label.</td>
</tr>
<tr>
<td class="name"><code>text</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="default">
</td>
<td class="description last">A Property specifying the text. Explicit newlines '\n' are supported.</td>
</tr>
<tr>
<td class="name"><code>font</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="default">
'30px sans-serif'
</td>
<td class="description last">A Property specifying the CSS font.</td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#LabelStyle">LabelStyle</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
LabelStyle.FILL
</td>
<td class="description last">A Property specifying the <a href="global.html#LabelStyle"><code>LabelStyle</code></a>.</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 text.</td>
</tr>
<tr>
<td class="name"><code>showBackground</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">
false
</td>
<td class="description last">A boolean Property specifying the visibility of the background behind the label.</td>
</tr>
<tr>
<td class="name"><code>backgroundColor</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">
new Color(0.165, 0.165, 0.165, 0.8)
</td>
<td class="description last">A Property specifying the background <a href="Color.html"><code>Color</code></a>.</td>
</tr>
<tr>
<td class="name"><code>backgroundPadding</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">
new Cartesian2(7, 5)
</td>
<td class="description last">A <a href="Cartesian2.html"><code>Cartesian2</code></a> Property specifying the horizontal and vertical background padding in pixels.</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>fillColor</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 fill <a href="Color.html"><code>Color</code></a>.</td>
</tr>
<tr>
<td class="name"><code>outlineColor</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.BLACK
</td>
<td class="description last">A Property specifying the outline <a href="Color.html"><code>Color</code></a>.</td>
</tr>
<tr>
<td class="name"><code>outlineWidth</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 outline width.</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>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 set scale based on distance from the camera.</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 label 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>